Add-AzureRmExpressRouteCircuitConnectionConfig

  • Reference
Module:
AzureRM.Network

Adds a circuit connection configuration to Private Peering of an Express Route Circuit.

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

Add-AzureRmExpressRouteCircuitConnectionConfig
   [-Name] <String>
   [-ExpressRouteCircuit] <PSExpressRouteCircuit>
   [-AddressPrefix] <String>
   [-AuthorizationKey <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzureRmExpressRouteCircuitConnectionConfig
   [-Name] <String>
   [-ExpressRouteCircuit] <PSExpressRouteCircuit>
   [-PeerExpressRouteCircuitPeering] <String>
   [-AddressPrefix] <String>
   [-AuthorizationKey <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-AzureRmExpressRouteCircuitConnectionConfig cmdlet adds a circuit connection configuration to private peering for an ExpressRoute circuit. This allows peering two Express Route Circuits across regions or subscriptions.Note that, after running Add-AzureRmExpressRouteCircuitPeeringConfig, you must call the Set-AzureRmExpressRouteCircuit cmdlet to activate the configuration.

Examples

Example 1: Add a circuit connection resource to an existing ExpressRoute circuit

$circuit_init = Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg
$circuit_peer = Get-AzureRmExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg
$addressSpace = '60.0.0.0/29'
Add-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey
Set-AzureRmExpressRouteCircuit -ExpressRouteCircuit $circuit_init

Example 2: Add a circuit connection configuration using Piping to an existing ExpressRoute Circuit

$circuit_peer = Get-AzureRmExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg
$addressSpace = '60.0.0.0/29'
Get-AzureRmExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg|Add-AzureRmExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey |Set-AzureRmExpressRouteCircuit

Parameters

-AddressPrefix

A minimum /29 customer address space to create VxLan tunnels between Express Route Circuits

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

-AuthorizationKey

Authorization Key to peer Express Route Circuit in another subscription. Authorization on peer circuit can be created using existing commands.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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 being modified. This is Azure object returned by the Get-AzureRmExpressRouteCircuit cmdlet.

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

-Name

The name of the circuit connection resource to be added.

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

-PeerExpressRouteCircuitPeering

Resource Id for Private Peering of remote circuit which will be peered with the current circuit.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSExpressRouteCircuit

Parameters: ExpressRouteCircuit (ByValue)

String

Outputs

PSExpressRouteCircuit