az network cross-connection

Note

This reference is part of the express-route-cross-connection extension for the Azure CLI (version 2.0.41 or higher). The extension will automatically install the first time you run an az network cross-connection command. Learn more about extensions.

Manage customers' ExpressRoute circuits.

To learn more about ExpressRoute circuits visit https://docs.microsoft.com/en-us/azure/expressroute/howto-circuit-cli.

Commands

Name	Description	Type	Status
az network cross-connection list	List all ExpressRoute cross-connections for the current subscription.	Extension	GA
az network cross-connection list-arp-tables	Show the current Address Resolution Protocol (ARP) table of an ExpressRoute cross-connection peering.	Extension	GA
az network cross-connection list-route-tables	Show the current routing table of an ExpressRoute cross-connection peering.	Extension	GA
az network cross-connection peering	Manage ExpressRoute peering of an ExpressRoute cross-connection.	Extension	GA
az network cross-connection peering create	Create peering settings for an ExpressRoute cross-connection.	Extension	GA
az network cross-connection peering delete	Delete peering settings.	Extension	GA
az network cross-connection peering list	List peering settings of an ExpressRoute cross-connection.	Extension	GA
az network cross-connection peering show	Get the details of an express route peering.	Extension	GA
az network cross-connection peering update	Update peering settings for an ExpressRoute cross-connection.	Extension	GA
az network cross-connection show	Get the details of an ExpressRoute cross-connection.	Extension	GA
az network cross-connection summarize-route-table	Gets the route table summary associated with the express route cross connection in a resource group.	Extension	GA
az network cross-connection update	Update settings of an ExpressRoute cross-connection.	Extension	GA
az network cross-connection wait	Place the CLI in a waiting state until a condition of the ExpressRoute is met.	Extension	GA

az network cross-connection list

List all ExpressRoute cross-connections for the current subscription.

az network cross-connection list [--resource-group]

Examples

List all ExpressRoute cross-connections for the current subscription.

az network cross-connection list -g MyResourceGroup

Optional Parameters

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

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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 cross-connection list-arp-tables

Show the current Address Resolution Protocol (ARP) table of an ExpressRoute cross-connection peering.

az network cross-connection list-arp-tables --path {primary, secondary}
                                            --peering-name
                                            [--ids]
                                            [--name]
                                            [--resource-group]
                                            [--subscription]

Examples

Show the current Address Resolution Protocol (ARP) table of an ExpressRoute cross-connection.

az network cross-connection list-arp-tables -g MyResourceGroup -n MyCircuit \
    --path primary --peering-name AzurePrivatePeering

Required Parameters

--path

The path of the device.

accepted values: primary, secondary

--peering-name

The name of the peering.

Optional Parameters

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

ExpressRoute cross-connection name.

--resource-group -g

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

--subscription

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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 cross-connection list-route-tables

Show the current routing table of an ExpressRoute cross-connection peering.

az network cross-connection list-route-tables --path {primary, secondary}
                                              --peering-name
                                              [--ids]
                                              [--name]
                                              [--resource-group]
                                              [--subscription]

Examples

Show the current routing table of an ExpressRoute cross-connection peering.

az network cross-connection list-route-tables -g MyResourceGroup -n MyCircuit \
    --path primary --peering-name AzurePrivatePeering

Required Parameters

--path

The path of the device.

accepted values: primary, secondary

--peering-name

The name of the peering.

Optional Parameters

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

ExpressRoute cross-connection name.

--resource-group -g

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

--subscription

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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 cross-connection show

Get the details of an ExpressRoute cross-connection.

az network cross-connection show [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

Examples

Get the details of an ExpressRoute cross-connection.

az network cross-connection show -n MyCircuit -g MyResourceGroup

Optional Parameters

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

ExpressRoute cross-connection name.

--resource-group -g

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

--subscription

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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 cross-connection summarize-route-table

Gets the route table summary associated with the express route cross connection in a resource group.

az network cross-connection summarize-route-table --path {primary, secondary}
                                                  --peering-name
                                                  [--ids]
                                                  [--name]
                                                  [--resource-group]
                                                  [--subscription]

Required Parameters

--path

The path of the device.

accepted values: primary, secondary

--peering-name

The name of the peering.

Optional Parameters

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

ExpressRoute cross-connection name.

--resource-group -g

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

--subscription

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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 cross-connection update

Update settings of an ExpressRoute cross-connection.

az network cross-connection update [--add]
                                   [--force-string]
                                   [--ids]
                                   [--name]
                                   [--no-wait]
                                   [--notes]
                                   [--provisioning-state {NotProvisioned, Provisioned, Provisioning}]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

default value: []

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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.

--name -n

ExpressRoute cross-connection name.

--no-wait

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

default value: False

--notes

Service provider notes.

--provisioning-state

Provisioning state of the customer ExpressRoute circuit.

accepted values: NotProvisioned, Provisioned, Provisioning

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

default value: []

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

default value: []

--subscription

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

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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 cross-connection wait

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

az network cross-connection wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--ids]
                                 [--interval]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

Examples

Pause executing next line of CLI script until the ExpressRoute cross-connection is successfully provisioned.

az network cross-connection wait -n MyCircuit -g MyResourceGroup --created

Optional Parameters

--created

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

default value: False

--custom

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

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

default value: 30

--name -n

ExpressRoute cross-connection name.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

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.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

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