Share via

az network express-route peering connection

Manage ExpressRoute circuit connections.

Commands

Name Description Type Status
az network express-route peering connection create

Create connections between two ExpressRoute circuits.

 Core GA
az network express-route peering connection delete

Delete the specified Express Route Circuit Connection from the specified express route circuit.

 Core GA
az network express-route peering connection ipv6-config

Manage ExpressRoute circuit connection configs.

 Core GA
az network express-route peering connection ipv6-config remove

Remove connection config to ExpressRoute circuit connection.

 Core GA
az network express-route peering connection ipv6-config set

Set connection config to ExpressRoute circuit connection.

 Core GA
az network express-route peering connection ipv6-config wait

Place the CLI in a waiting state until a condition is met.

 Core GA
az network express-route peering connection list

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

 Core GA
az network express-route peering connection show

Get the specified Express Route Circuit Connection from the specified express route circuit.

 Core GA
az network express-route peering connection wait

Place the CLI in a waiting state until a condition is met.

 Core GA

az network express-route peering connection create

Edit

Create connections between two ExpressRoute circuits.

az network express-route peering connection create --circuit-name
                                                   --name
                                                   --peering-name
                                                   --resource-group
                                                   [--address-prefix]
                                                   [--authorization-key]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--peer-circuit]
                                                   [--source-circuit]

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

--circuit-name

ExpressRoute circuit name.

--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>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--address-prefix

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

--authorization-key

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

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--peer-circuit

Name or ID of the peer ExpressRoute circuit.

--source-circuit

Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection.

Property Value
Parameter group: ExpressRouteCircuitPeering Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network express-route peering connection delete

Edit

Delete the specified Express Route Circuit Connection from the specified express route circuit.

az network express-route peering connection delete [--circuit-name]
                                                   [--ids]
                                                   [--name]
                                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                   [--peering-name]
                                                   [--resource-group]
                                                   [--subscription]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--circuit-name

ExpressRoute circuit name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the peering connection.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--peering-name

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

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az network express-route peering connection list

Edit

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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network express-route peering connection show

Edit

Get the specified Express Route Circuit Connection from the specified express route circuit.

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

Examples

Show ExpressRouteCircuit Connection

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--circuit-name

ExpressRoute circuit name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name -n

Name of the peering connection.

Property Value
Parameter group: Resource Id Arguments
--peering-name

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

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az network express-route peering connection wait

Edit

Place the CLI in a waiting state until a condition is met.

az network express-route peering connection wait [--circuit-name]
                                                 [--created]
                                                 [--custom]
                                                 [--deleted]
                                                 [--exists]
                                                 [--ids]
                                                 [--interval]
                                                 [--name]
                                                 [--peering-name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--timeout]
                                                 [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--circuit-name

ExpressRoute circuit name.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name -n

Name of the peering connection.

Property Value
Parameter group: Resource Id Arguments
--peering-name

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

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False