az network express-route peering connection

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage ExpressRoute circuit connections.

Commands

az network express-route peering connection create	Create connections between two ExpressRoute circuits.
az network express-route peering connection delete	Delete an ExpressRoute circuit connection.
az network express-route peering connection ipv6-config	Manage ExpressRoute circuit connection configs.
az network express-route peering connection ipv6-config remove	Remove connection config to ExpressRoute circuit connection.
az network express-route peering connection ipv6-config set	Set connection config to ExpressRoute circuit connection.
az network express-route peering connection list	List all global reach connections associated with a private peering in an express route circuit.
az network express-route peering connection show	Get the details of an ExpressRoute circuit connection.

az network express-route peering connection create

Create connections between two ExpressRoute circuits.

az network express-route peering connection create --address-prefix
                                                   --circuit-name
                                                   --name
                                                   --peer-circuit
                                                   --peering-name
                                                   --resource-group
                                                   [--authorization-key]

Examples

Create connection between two ExpressRoute circuits with AzurePrivatePeering settings.

az network express-route peering connection create -g MyResourceGroup --circuit-name \
    MyCircuit --peering-name AzurePrivatePeering -n myConnection --peer-circuit \
    MyOtherCircuit --address-prefix 104.0.0.0/29

Required Parameters

--address-prefix

/29 IP address space to carve out customer addresses for tunnels.

--circuit-name

ExpressRoute circuit name.

--name -n

Name of the peering connection.

--peer-circuit

Name or ID of the peer ExpressRoute circuit.

--peering-name

Name of BGP peering (i.e. AzurePrivatePeering).

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--authorization-key

The authorization key used when the peer circuit is in another subscription.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network express-route peering connection delete

Delete an ExpressRoute circuit connection.

az network express-route peering connection delete [--circuit-name]
                                                   [--ids]
                                                   [--name]
                                                   [--peering-name]
                                                   [--resource-group]

Examples

Delete an ExpressRoute circuit connection. (autogenerated)

az network express-route peering connection delete --circuit-name MyCircuit --name MyPeeringConnection --peering-name MyPeering --resource-group MyResourceGroup

Optional Parameters

--circuit-name

ExpressRoute circuit name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the peering connection.

--peering-name

Name of BGP peering (i.e. AzurePrivatePeering).

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network express-route peering connection list

List all global reach connections associated with a private peering in an express route circuit.

az network express-route peering connection list --circuit-name
                                                 --peering-name
                                                 --resource-group

Examples

List ExpressRouteCircuit Connection

az network express-route peering connection list --circuit-name MyCircuit --peering-name MyPeering --resource-group MyResourceGroup

Required Parameters

--circuit-name

ExpressRoute circuit name.

--peering-name

Name of BGP peering (i.e. AzurePrivatePeering).

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network express-route peering connection show

Get the details of an ExpressRoute circuit connection.

az network express-route peering connection show [--circuit-name]
                                                 [--ids]
                                                 [--name]
                                                 [--peering-name]
                                                 [--resource-group]

Optional Parameters

--circuit-name

ExpressRoute circuit name.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the peering connection.

--peering-name

Name of BGP peering (i.e. AzurePrivatePeering).

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.