Add-​Azure​Rm​Express​Route​Circuit​Peering​Config

Adds a peering configuration to an ExpressRoute circuit.

Syntax

Add-AzureRmExpressRouteCircuitPeeringConfig
   -ExpressRouteCircuit <PSExpressRouteCircuit>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>]
   [-MicrosoftConfigCustomerAsn <Int32>]
   [-MicrosoftConfigRoutingRegistryName <String>]
   -Name <String>
   -PeerASN <Int32>
   -PeeringType <String>
   -PrimaryPeerAddressPrefix <String>
   -SecondaryPeerAddressPrefix <String>
   [-SharedKey <String>]
   -VlanId <Int32>
   [<CommonParameters>]
Add-AzureRmExpressRouteCircuitPeeringConfig
   -ExpressRouteCircuit <PSExpressRouteCircuit>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -Name <String>
   -PeerASN <Int32>
   -PeeringType <String>
   -PrimaryPeerAddressPrefix <String>
   [-RouteFilter <PSRouteFilter>]
   -SecondaryPeerAddressPrefix <String>
   [-SharedKey <String>]
   -VlanId <Int32>
   [<CommonParameters>]
Add-AzureRmExpressRouteCircuitPeeringConfig
   -ExpressRouteCircuit <PSExpressRouteCircuit>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -Name <String>
   -PeerASN <Int32>
   -PeeringType <String>
   -PrimaryPeerAddressPrefix <String>
   [-RouteFilterId <String>]
   -SecondaryPeerAddressPrefix <String>
   [-SharedKey <String>]
   -VlanId <Int32>
   [<CommonParameters>]

Description

The Add-AzureRmExpressRouteCircuitPeeringConfig cmdlet adds a peering configuration to an ExpressRoute circuit. ExpressRoute circuits connect your on-premises network to the Microsoft cloud by using a connectivity provider instead of the public Internet. Note that, after running Add-AzureRmExpressRouteCircuitPeeringConfig, you must call the Set-AzureRmExpressRouteCircuit cmdlet to activate the configuration.

Examples

Example 1: Add a peer to an existing ExpressRoute circuit

$circuit = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $rg
$parameters = @{
    Name = 'AzurePrivatePeering'
    Circuit = $circuit
    PeeringType = 'AzurePrivatePeering'
    PeerASN = 100
    PrimaryPeerAddressPrefix = '10.6.1.0/30'
    SecondaryPeerAddressPrefix = '10.6.2.0/30'
    VlanId  = 200
}
Add-AzureRmExpressRouteCircuitPeeringConfig @parameters
Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit

Required Parameters

-ExpressRouteCircuit

The ExpressRoute circuit being modified. This is Azure object returned by the Get-AzureRmExpressRouteCircuit cmdlet.

Type:PSExpressRouteCircuit
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Name

The name of the peering relationship to be added.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PeerASN

The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is AzurePublicPeering.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PeeringType

The acceptable values for this parameter are: AzurePrivatePeering, AzurePublicPeering, and MicrosoftPeering

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PrimaryPeerAddressPrefix

This is the IP Address range for the primary routing path of this peering relationship. This must be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your router interface. Azure will configure the next even-numbered address to the Azure router interface.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SecondaryPeerAddressPrefix

This is the IP Address range for the secondary routing path of this peering relationship. This must be a /30 CIDR subnet. The first odd-numbered address in this subnet should be assigned to your router interface. Azure will configure the next even-numbered address to the Azure router interface.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VlanId

This is the Id number of the VLAN assigned for this peering.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MicrosoftConfigAdvertisedPublicPrefixes

For a PeeringType of MicrosoftPeering, you must provide a list of all prefixes you plan to advertise over the BGP session. Only public IP address prefixes are accepted. You can send a comma separated list if you plan to send a set of prefixes. These prefixes must be registered to you in a Routing Registry Name (RIR / IRR).

Type:System.Collections.Generic.List`1[System.String]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MicrosoftConfigCustomerAsn

If you are advertising prefixes that are not registered to the peering AS number, you can specify the AS number to which they are registered.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MicrosoftConfigRoutingRegistryName

The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RouteFilter

This is an existing RouteFilter object.

Type:PSRouteFilter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RouteFilterId

This is the resource Id of an existing RouteFilter object.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SharedKey

This is an optional MD5 hash used as a pre-shared key for the peering configuration.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False