Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-AzureBGPPeering

Set-AzureBGPPeering

microsoft.windowsazure.commands.expressroute.dll

Synopsis

Updates a BGP peering configuration for an ExpressRoute circuit.

Syntax

Set-AzureBGPPeering [-ServiceKey] [-PeerAsn] [-PrimaryPeerSubnet] [-SecondaryPeerSubnet] [-SharedKey] [-VlanId] [-AccessType] [<CommonParameters>]

Detailed Description

The Set-AzureBGPPeering cmdlet updates the routing configuration for an ExpressRoute circuit. This cmdlet works only for circuits established with an internet exchange point service provider. This cmdlet does not work for circuits established through carriers.

Parameters

-ServiceKey <String>

Specifies the service key of the ExpressRoute circuit for which to create a BGP session.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PeerAsn <Nullable`1[UInt32]>

Specifies the customer's AS number for the BGP session. Customers can use either a public AS number they own or choose a private AS number. Customers must not use AS number 65515 if they are using private AS numbers.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PrimaryPeerSubnet <String>

Specifies one of the peering subnets in CIDR notation from which I addresses will be selected for establishing a BGP session. If the subnet 10.0.0.0/30 is specified, the customer uses 10.0.0.1 for their VRF and Azure will select 10.0.0.2 for it's VRF to establish a BGP session. This subnet must not overlap with any of the virtual networks' address ranges used in Microsoft Azure.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-SecondaryPeerSubnet <String>

Specifies the second peering subnets in CIDR notation from which I addresses will be selected for establishing a BGP session. If the subnet 10.0.0.4/30 is specified, the customer uses 10.0.0.5 for their VRF and Azure will select 10.0.0.6 for it's VRF to establish a BGP session. This subnet must not overlap with any of the virtual networks' address ranges used in Microsoft Azure.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-SharedKey <String>

Specifies the MD5 hash to be used for the BGP session. The hash bust be a 16-byte hash value represented as a 32 digit hexadecimal number.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-VlanId <Nullable`1[UInt32]>

Specifies the VLAN ID over which a BGP session will be established for the ExpressRoute circuit.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-AccessType <BgpPeeringAccessType>

Access type can be either Public or Private. Private (the default value) sets up a BGP session to be used with virtual networks. Public sets up a BGP session to be used to access public IP addresses in the service, including VIPs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

Updates the BGP session for an ExpressRoute circuit with service key "12345678-1234-1234-abcd-1234567890ab". The BGP session with AS number 65014 is established on VLAN ID 100.

PS C:\> C:\PS>Set-AzureBGPPeering -ServiceKey "12345678-1234-1234-abcd-1234567890ab" -VlanId 100 -PeerAsn 65014 -PrimaryPeerSubnet "10.0.0.0/30" -SecondaryPeerSubnet "10.0.0.4/30"

Get-AzureBGPPeering
Get-AzureDedicatedCircuit
Get-AzureDedicatedCircuitLink
Get-AzureDedicatedCircuitServiceProvider
New-AzureBGPPeering
New-AzureDedicatedCircuit
New-AzureDedicatedCircuitLink
Remove-AzureBGPPeering
Remove-AzureDedicatedCircuit
Remove-AzureDedicatedCircuitLink
Set-AzureBGPPeering