Edit

Share via


Get-AzExpressRouteCircuitConnectionConfig

Gets an ExpressRoute circuit connection configuration associated with Private Peering of ExpressRouteCircuit.

Syntax

Default (Default)

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

Description

The Get-AzExpressRouteCircuitConnectionConfig cmdlet retrieves the configuration of a circuit connection associated with Private Peering for an ExpressRoute circuit.

Examples

Example 1: Display the circuit connection configuration for an ExpressRoute circuit

$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg
Get-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init

Example 2: Get circuit connection resource associated with an ExpressRoute Circuit using piping

Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Get-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName

Parameters

-DefaultProfile

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

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExpressRouteCircuit

The ExpressRoute circuit object containing the circuit connection configuration.

Parameter properties

Type:PSExpressRouteCircuit
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the circuit connection configuration to be retrieved.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

PSExpressRouteCircuit

Outputs

PSExpressRouteCircuitConnection