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
 

Get-AzureBGPPeering

Get-AzureBGPPeering

microsoft.windowsazure.commands.expressroute.dll

Synopsis

Returns an object with bgp configuration information of an ExpressRouteCircuit

Syntax

Get-AzureBGPPeering [-ServiceKey] [-AccessType] [<CommonParameters>]

Detailed Description

The Get-AzureBGPPeering cmdlet gets the routing configuration for an ExpressRoute circuit. It returns an object with information on a specific ExpressRoute circuit for which a service key is provided. 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 retrieve circuit routing information.

Aliases

None

Required?

true

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

ManagementOperationContext

Notes

Examples

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

This command returns an object with information on the routing configuration for the ExpressRoute circuit with service key "12345678-1234-1234-abcd-1234567890ab".

PS C:\> C:\PS>Get-AzureBGPPeering -ServiceKey "12345678-1234-1234-abcd-1234567890ab"

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