az network cross-connection
Note
This reference is part of the express-route-cross-connection extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az network cross-connection command. Learn more about extensions.
Manage express route cross connection.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network cross-connection list |
List all express route 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 express route cross connection peering. |
Extension | GA |
az network cross-connection list-route-tables |
Show the current routing table of an express route cross connection peering. |
Extension | GA |
az network cross-connection peering |
Manage express route cross connection peering. |
Extension | GA |
az network cross-connection peering create |
Create peering settings for an express route 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 express route cross connection. |
Extension | GA |
az network cross-connection peering show |
Show the details of an express route peering. |
Extension | GA |
az network cross-connection peering update |
Update peering settings for an express route cross connection. |
Extension | GA |
az network cross-connection peering wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az network cross-connection show |
Show the details of an express route cross connection. |
Extension | GA |
az network cross-connection summarize-route-table |
Show 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 express route cross-connection. |
Extension | GA |
az network cross-connection wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az network cross-connection list
List all express route cross-connections for the current subscription.
az network cross-connection list [--max-items]
[--next-token]
[--resource-group]
Examples
List all express route cross connections for the current subscription.
az network cross-connection list -g MyResourceGroup
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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 express route cross connection peering.
az network cross-connection list-arp-tables --path {primary, secondary}
--peering-name
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Show the current address resolution protocol (ARP) table of an express route cross-connection.
az network cross-connection list-arp-tables -g MyResourceGroup -n MyCircuit --path primary --peering-name AzurePrivatePeering
Required Parameters
The path of the device.
The name of the peering.
Optional Parameters
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.
Express route cross-connection name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-connection list-route-tables
Show the current routing table of an express route cross connection peering.
az network cross-connection list-route-tables --path {primary, secondary}
--peering-name
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Show the current routing table of an express route cross-connection peering.
az network cross-connection list-route-tables -g MyResourceGroup -n MyCircuit --path primary --peering-name AzurePrivatePeering
Required Parameters
The path of the device.
The name of the peering.
Optional Parameters
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.
Express route cross-connection name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-connection show
Show the details of an express route cross connection.
az network cross-connection show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Show the details of an express route cross-connection.
az network cross-connection show -n MyCircuit -g MyResourceGroup
Optional Parameters
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.
Express route cross-connection name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-connection summarize-route-table
Show 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]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Required Parameters
The path of the device.
The name of the peering.
Optional Parameters
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.
Express route cross-connection name.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-connection update
Update settings of an express route cross-connection.
az network cross-connection update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--notes]
[--provisioning-state {Deprovisioning, NotProvisioned, Provisioned, Provisioning}]
[--remove]
[--resource-group]
[--set]
[--subscription]
Optional Parameters
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>
.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Express route cross-connection name.
Do not wait for the long-running operation to finish.
Additional read only notes set by the connectivity provider.
The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az network cross-connection wait
Place the CLI in a waiting state until a condition is met.
az network cross-connection wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
Express route cross-connection name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.