Edit

Share via

Set-AzExpressRouteCircuitConnectionConfig

Module:
Az.Network Module

Updates a circuit connection configuration created in Private Peerings for an Express Route Circuit.

Syntax

SetByResource (Default) 

Set-AzExpressRouteCircuitConnectionConfig
    [-Name] <String>
    [-ExpressRouteCircuit] <PSExpressRouteCircuit>
    [-AddressPrefix] <String>
    [-AddressPrefixType <String>]
    [-AuthorizationKey <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetByResourceId 

Set-AzExpressRouteCircuitConnectionConfig
    [-Name] <String>
    [-ExpressRouteCircuit] <PSExpressRouteCircuit>
    [-PeerExpressRouteCircuitPeering] <String>
    [-AddressPrefix] <String>
    [-AddressPrefixType <String>]
    [-AuthorizationKey <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AzExpressRouteCircuitConnectionConfig cmdlet updates a circuit connection configuration created in private peering for an ExpressRoute circuit. This allows peering two Express Route Circuits across regions or subscriptions. Note that, before running Set-AzExpressRouteCircuitConnectionConfig you must add the circuit connection using Add-AzExpressRouteCircuitConnectionConfig. Also, after running Set-AzExpressRouteCircuitPeeringConfig, you must call the Set-AzExpressRouteCircuit cmdlet to activate the configuration.

Examples

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

$circuit_init = Get-AzExpressRouteCircuit -Name $initiatingCircuitName -ResourceGroupName $rg
$circuit_peer = Get-AzExpressRouteCircuit -Name $peeringCircuitName -ResourceGroupName $rg
$addressSpace = 'aa:bb::0/125'
$addressPrefixType = 'IPv6'
Set-AzExpressRouteCircuitConnectionConfig -Name $circuitConnectionName -ExpressRouteCircuit $circuit_init -PeerExpressRouteCircuitPeering $circuit_peer.Peerings[0].Id -AddressPrefix $addressSpace -AddressPrefixType $addressPrefixType -AuthorizationKey $circuit_peer.Authorizations[0].AuthorizationKey
Set-AzExpressRouteCircuit -ExpressRouteCircuit $circuit_init

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

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

Parameters

-AddressPrefix

A minimum /29 customer address space to create VxLan tunnels between Express Route Circuits for IPv4 tunnels. or a minimum of /125 customer address space to create VxLan tunnels between Express Route Circuits for IPv6 tunnels.

Parameter properties

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

Parameter sets

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

-AddressPrefixType

Specifies the address family that address prefix belongs to.

Parameter properties

Type:String
Default value:IPv4
Accepted values:IPv4, IPv6
Supports wildcards:False
DontShow:False

Parameter sets

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

-AuthorizationKey

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

Parameter properties

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

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

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

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 resource to be added.

Parameter properties

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

Parameter sets

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

-PeerExpressRouteCircuitPeering

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

Parameter properties

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

Parameter sets

SetByResourceId
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
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

String

Outputs

PSExpressRouteCircuit