Edit

Share via

Get-AzureRmExpressRouteCircuitPeeringConfig

  • Reference
Module:
AzureRM.Network

Gets an ExpressRoute circuit peering configuration.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Get-AzureRmExpressRouteCircuitPeeringConfig
   [-Name <String>]
   -ExpressRouteCircuit <PSExpressRouteCircuit>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmExpressRouteCircuitPeeringConfig cmdlet retrieves the configuration of a peering relationship for an ExpressRoute circuit.

Examples

Example 1: Display the peering configuration for an ExpressRoute circuit

$ckt = Get-AzureRmExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG
Get-AzureRmExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ckt

Parameters

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExpressRouteCircuit

The ExpressRoute circuit object containing the peering configuration.

Type:PSExpressRouteCircuit
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the peering configuration to be retrieved.

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

Inputs

PSExpressRouteCircuit

Parameters: ExpressRouteCircuit (ByValue)

Outputs

PSPeering