Edit

Share via

Get-AzExpressRouteCircuitPeeringConfig

  • Reference
Module:
Az.Network

Gets an ExpressRoute circuit peering configuration.

Syntax

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

Description

The Get-AzExpressRouteCircuitPeeringConfig 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-AzExpressRouteCircuit -Name $CircuitName -ResourceGroupName $RG
Get-AzExpressRouteCircuitPeeringConfig -Name "AzurePrivatePeering" -ExpressRouteCircuit $ckt

Parameters

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, 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

Outputs

PSPeering