Get-AzureRmExpressRouteCircuitConnectionConfig

  • Reference
Module:
AzureRM.Network

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

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-AzureRmExpressRouteCircuitConnectionConfig
   [-Name] <String>
   [-ExpressRouteCircuit] <PSExpressRouteCircuit>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzureRmExpressRouteCircuitConnectionConfig 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-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg
Get-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init

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

Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Get-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName

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 circuit connection configuration.

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

-Name

The name of the circuit connection configuration to be retrieved.

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

Inputs

PSExpressRouteCircuit

Parameters: ExpressRouteCircuit (ByValue)

Outputs

PSExpressRouteCircuitConnection