Edit

Share via

Add-AzExpressRouteCircuitPeeringConfig

Module:
Az.Network Module

Adds a peering configuration to an ExpressRoute circuit.

Syntax

SetByResource (Default) 

Add-AzExpressRouteCircuitPeeringConfig
    -Name <String>
    -ExpressRouteCircuit <PSExpressRouteCircuit>
    -PeeringType <String>
    -PeerASN <UInt32>
    -PrimaryPeerAddressPrefix <String>
    -SecondaryPeerAddressPrefix <String>
    -VlanId <Int32>
    [-SharedKey <String>]
    [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>]
    [-MicrosoftConfigCustomerAsn <Int32>]
    [-MicrosoftConfigRoutingRegistryName <String>]
    [-PeerAddressType <String>]
    [-LegacyMode <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

MicrosoftPeeringConfigRoutFilterId 

Add-AzExpressRouteCircuitPeeringConfig
    -Name <String>
    -ExpressRouteCircuit <PSExpressRouteCircuit>
    -PeeringType <String>
    -PeerASN <UInt32>
    -PrimaryPeerAddressPrefix <String>
    -SecondaryPeerAddressPrefix <String>
    -VlanId <Int32>
    -RouteFilterId <String>
    [-SharedKey <String>]
    [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>]
    [-MicrosoftConfigCustomerAsn <Int32>]
    [-MicrosoftConfigRoutingRegistryName <String>]
    [-PeerAddressType <String>]
    [-LegacyMode <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

MicrosoftPeeringConfigRoutFilter 

Add-AzExpressRouteCircuitPeeringConfig
    -Name <String>
    -ExpressRouteCircuit <PSExpressRouteCircuit>
    -PeeringType <String>
    -PeerASN <UInt32>
    -PrimaryPeerAddressPrefix <String>
    -SecondaryPeerAddressPrefix <String>
    -VlanId <Int32>
    -RouteFilter <PSRouteFilter>
    [-SharedKey <String>]
    [-MicrosoftConfigAdvertisedPublicPrefixes <String[]>]
    [-MicrosoftConfigCustomerAsn <Int32>]
    [-MicrosoftConfigRoutingRegistryName <String>]
    [-PeerAddressType <String>]
    [-LegacyMode <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Add-AzExpressRouteCircuitPeeringConfig 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-AzExpressRouteCircuitPeeringConfig, you must call the Set-AzExpressRouteCircuit cmdlet to activate the configuration.

Examples

Example 1: Add a peer to an existing ExpressRoute circuit

$circuit = Get-AzExpressRouteCircuit -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-AzExpressRouteCircuitPeeringConfig @parameters
Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit

Example 2

Adds a peering configuration to an ExpressRoute circuit. (autogenerated)

Add-AzExpressRouteCircuitPeeringConfig -ExpressRouteCircuit <PSExpressRouteCircuit> -MicrosoftConfigAdvertisedPublicPrefixes <String[]> -MicrosoftConfigCustomerAsn <Int32> -MicrosoftConfigRoutingRegistryName <String> -Name 'AzurePrivatePeering' -PeerASN 100 -PeerAddressType IPv4 -PeeringType AzurePrivatePeering -PrimaryPeerAddressPrefix '123.0.0.0/30' -SecondaryPeerAddressPrefix '123.0.0.4/30' -VlanId 300

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExpressRouteCircuit

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

Parameter properties

Type:PSExpressRouteCircuit
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-LegacyMode

The legacy mode of the Peering

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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).

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MicrosoftConfigRoutingRegistryName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the peering relationship to be added.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PeerAddressType

PeerAddressType

Parameter properties

Type:String
Default value:None
Accepted values:IPv4, IPv6
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-PeerASN

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

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PeeringType

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

Parameter properties

Type:String
Default value:None
Accepted values:AzurePrivatePeering, AzurePublicPeering, MicrosoftPeering
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RouteFilter

This is an existing RouteFilter object.

Parameter properties

Type:PSRouteFilter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

MicrosoftPeeringConfigRoutFilter
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RouteFilterId

This is the resource Id of an existing RouteFilter object.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

MicrosoftPeeringConfigRoutFilterId
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SharedKey

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VlanId

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSExpressRouteCircuit

String

PSRouteFilter

Boolean

Outputs

PSExpressRouteCircuit