< Back
Set-AzureRmExpressRouteCircuitPeeringConfig
Post
NAME Set-AzureRmExpressRouteCircuitPeeringConfig
SYNOPSIS
Saves a modified ExpressRoute peering configuration.
SYNTAX
Set-AzureRmExpressRouteCircuitPeeringConfig [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-LegacyMode
<Boolean>] [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] [-MicrosoftConfigCustomerAsn <Int32>]
[-MicrosoftConfigRoutingRegistryName <String>] -Name <String> [-PeerAddressType {IPv4 | IPv6}] -PeerASN <UInt32> -PeeringType {AzurePrivatePeering
| AzurePublicPeering | MicrosoftPeering} -PrimaryPeerAddressPrefix <String> -RouteFilter <PSRouteFilter> -SecondaryPeerAddressPrefix <String>
[-SharedKey <String>] -VlanId <Int32> [<CommonParameters>]
Set-AzureRmExpressRouteCircuitPeeringConfig [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-LegacyMode
<Boolean>] [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] [-MicrosoftConfigCustomerAsn <Int32>]
[-MicrosoftConfigRoutingRegistryName <String>] -Name <String> [-PeerAddressType {IPv4 | IPv6}] -PeerASN <UInt32> -PeeringType {AzurePrivatePeering
| AzurePublicPeering | MicrosoftPeering} -PrimaryPeerAddressPrefix <String> -RouteFilterId <String> -SecondaryPeerAddressPrefix <String>
[-SharedKey <String>] -VlanId <Int32> [<CommonParameters>]
DESCRIPTION
The Set-AzureRmExpressRouteCircuitPeeringConfig cmdlets saves a modified ExpressRoute peering configuration back to Azure.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpressRouteCircuit <PSExpressRouteCircuit>
The ExpressRoute circuit object containing the peering configuration to be modified.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LegacyMode <Boolean>
The legacy mode of the Peering
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>
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).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MicrosoftConfigCustomerAsn <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MicrosoftConfigRoutingRegistryName <String>
The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The name of the peering configuration to be modified.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PeerAddressType <String>
PeerAddressType
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PeerASN <UInt32>
The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is AzurePublicPeering.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PeeringType <String>
The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and `MicrosoftPeering`
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PrimaryPeerAddressPrefix <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RouteFilter <PSRouteFilter>
This is an existing RouteFilter object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RouteFilterId <String>
This is the resource Id of an existing RouteFilter object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SecondaryPeerAddressPrefix <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SharedKey <String>
This is an optional MD5 hash used as a pre-shared key for the peering configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VlanId <Int32>
This is the Id number of the VLAN assigned for this peering.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSExpressRouteCircuit
Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit
NOTES
Example 1: Change an existing peering configuration
$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 = 201
}
Set-AzureRmExpressRouteCircuitPeeringConfig @parameters
Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ringconfig
Add-AzureRmExpressRouteCircuitPeeringConfig
Get-AzureRmExpressRouteCircuit
New-AzureRmExpressRouteCircuitPeeringConfig
Remove-AzureRmExpressRouteCircuitPeeringConfig
SYNOPSIS
Saves a modified ExpressRoute peering configuration.
SYNTAX
Set-AzureRmExpressRouteCircuitPeeringConfig [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-LegacyMode
<Boolean>] [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] [-MicrosoftConfigCustomerAsn <Int32>]
[-MicrosoftConfigRoutingRegistryName <String>] -Name <String> [-PeerAddressType {IPv4 | IPv6}] -PeerASN <UInt32> -PeeringType {AzurePrivatePeering
| AzurePublicPeering | MicrosoftPeering} -PrimaryPeerAddressPrefix <String> -RouteFilter <PSRouteFilter> -SecondaryPeerAddressPrefix <String>
[-SharedKey <String>] -VlanId <Int32> [<CommonParameters>]
Set-AzureRmExpressRouteCircuitPeeringConfig [-DefaultProfile <IAzureContextContainer>] -ExpressRouteCircuit <PSExpressRouteCircuit> [-LegacyMode
<Boolean>] [-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>] [-MicrosoftConfigCustomerAsn <Int32>]
[-MicrosoftConfigRoutingRegistryName <String>] -Name <String> [-PeerAddressType {IPv4 | IPv6}] -PeerASN <UInt32> -PeeringType {AzurePrivatePeering
| AzurePublicPeering | MicrosoftPeering} -PrimaryPeerAddressPrefix <String> -RouteFilterId <String> -SecondaryPeerAddressPrefix <String>
[-SharedKey <String>] -VlanId <Int32> [<CommonParameters>]
DESCRIPTION
The Set-AzureRmExpressRouteCircuitPeeringConfig cmdlets saves a modified ExpressRoute peering configuration back to Azure.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpressRouteCircuit <PSExpressRouteCircuit>
The ExpressRoute circuit object containing the peering configuration to be modified.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-LegacyMode <Boolean>
The legacy mode of the Peering
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-MicrosoftConfigAdvertisedPublicPrefixes <System.Collections.Generic.List`1[System.String]>
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).
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MicrosoftConfigCustomerAsn <Int32>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-MicrosoftConfigRoutingRegistryName <String>
The Routing Registry Name (RIR / IRR) to which the AS number and prefixes are registered.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
The name of the peering configuration to be modified.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PeerAddressType <String>
PeerAddressType
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PeerASN <UInt32>
The AS number of your ExpressRoute circuit. This must be a Public ASN when the PeeringType is AzurePublicPeering.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PeeringType <String>
The acceptable values for this parameter are: `AzurePrivatePeering`, `AzurePublicPeering`, and `MicrosoftPeering`
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PrimaryPeerAddressPrefix <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-RouteFilter <PSRouteFilter>
This is an existing RouteFilter object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-RouteFilterId <String>
This is the resource Id of an existing RouteFilter object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SecondaryPeerAddressPrefix <String>
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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SharedKey <String>
This is an optional MD5 hash used as a pre-shared key for the peering configuration.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VlanId <Int32>
This is the Id number of the VLAN assigned for this peering.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PSExpressRouteCircuit
Parameter 'ExpressRouteCircuit' accepts value of type 'PSExpressRouteCircuit' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.Network.Models.PSExpressRouteCircuit
NOTES
Example 1: Change an existing peering configuration
$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 = 201
}
Set-AzureRmExpressRouteCircuitPeeringConfig @parameters
Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ringconfig
Add-AzureRmExpressRouteCircuitPeeringConfig
Get-AzureRmExpressRouteCircuit
New-AzureRmExpressRouteCircuitPeeringConfig
Remove-AzureRmExpressRouteCircuitPeeringConfig