az network express-route
Manage dedicated private network fiber connections to Azure.
To learn more about ExpressRoute circuits visit https://docs.microsoft.com/azure/expressroute/howto-circuit-cli.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network express-route auth |
Manage authentication of an ExpressRoute circuit. |
Core | GA |
az network express-route auth create |
Create a new link authorization for an ExpressRoute circuit. |
Core | GA |
az network express-route auth delete |
Delete a link authorization of an ExpressRoute circuit. |
Core | GA |
az network express-route auth list |
List link authorizations of an ExpressRoute circuit. |
Core | GA |
az network express-route auth show |
Get the details of a link authorization of an ExpressRoute circuit. |
Core | GA |
az network express-route auth wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route create |
Create an express route circuit. |
Core | GA |
az network express-route delete |
Delete an ExpressRoute circuit. |
Core | GA |
az network express-route gateway |
Manage ExpressRoute gateways. |
Core | GA |
az network express-route gateway connection |
Manage ExpressRoute gateway connections. |
Core | GA |
az network express-route gateway connection create |
Create an ExpressRoute gateway connection. |
Core | GA |
az network express-route gateway connection delete |
Delete an ExpressRoute gateway connection. |
Core | GA |
az network express-route gateway connection list |
List ExpressRoute gateway connections. |
Core | GA |
az network express-route gateway connection show |
Get the details of an ExpressRoute gateway connection. |
Core | GA |
az network express-route gateway connection update |
Update an ExpressRoute gateway connection. |
Core | GA |
az network express-route gateway connection wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route gateway create |
Create an ExpressRoute gateway. |
Core | GA |
az network express-route gateway delete |
Delete an ExpressRoute gateway. |
Core | GA |
az network express-route gateway list |
List ExpressRoute gateways. |
Core | GA |
az network express-route gateway show |
Get the details of an ExpressRoute gateway. |
Core | GA |
az network express-route gateway update |
Update settings of an ExpressRoute gateway. |
Core | GA |
az network express-route gateway wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route get-stats |
Get the statistics of an ExpressRoute circuit. |
Core | GA |
az network express-route list |
List all ExpressRoute circuits for the current subscription. |
Core | GA |
az network express-route list-arp-tables |
Show the current Address Resolution Protocol (ARP) table of an ExpressRoute circuit. |
Core | GA |
az network express-route list-route-tables |
Show the current routing table of an ExpressRoute circuit peering. |
Core | Preview |
az network express-route list-route-tables-summary |
Show the current routing table summary of an ExpressRoute circuit peering. |
Core | Preview |
az network express-route list-service-providers |
List available ExpressRoute service providers. |
Core | GA |
az network express-route peering |
Manage ExpressRoute peering of an ExpressRoute circuit. |
Core | GA |
az network express-route peering connection |
Manage ExpressRoute circuit connections. |
Core | GA |
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 create |
Create peering settings for an ExpressRoute circuit. |
Core | GA |
az network express-route peering delete |
Delete peering settings. |
Core | GA |
az network express-route peering get-stats |
Get all traffic stats of an ExpressRoute peering. |
Core | Preview |
az network express-route peering list |
List peering settings of an ExpressRoute circuit. |
Core | GA |
az network express-route peering peer-connection |
Manage ExpressRoute circuit peer connections. |
Core | Preview |
az network express-route peering peer-connection list |
Gets all global reach peer connections associated with a private peering in an express route circuit. |
Core | Preview |
az network express-route peering peer-connection show |
Get the specified Peer Express Route Circuit Connection from the specified express route circuit. |
Core | Preview |
az network express-route peering show |
Get the details of an express route peering. |
Core | GA |
az network express-route peering update |
Update peering settings of an ExpressRoute circuit. |
Core | GA |
az network express-route peering wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route port |
Manage ExpressRoute ports. |
Core | GA |
az network express-route port authorization |
Manage ExpressRoute ports authorzation. |
Core | GA |
az network express-route port authorization create |
Create an authorization in the specified express route port. |
Core | GA |
az network express-route port authorization delete |
Delete the specified authorization from the specified express route port. |
Core | GA |
az network express-route port authorization list |
List all authorizations in an express route port. |
Core | GA |
az network express-route port authorization show |
Get the specified authorization from the specified express route port. |
Core | GA |
az network express-route port authorization update |
Update an authorization in the specified express route port. |
Core | GA |
az network express-route port authorization wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route port create |
Create an ExpressRoute port. |
Core | GA |
az network express-route port delete |
Delete an ExpressRoute port. |
Core | GA |
az network express-route port generate-loa |
Generate and download a letter of authorization for the requested ExpressRoutePort. |
Core | GA |
az network express-route port identity |
Manage the managed service identity of an ExpressRoute Port. |
Core | GA |
az network express-route port identity assign |
Assign a managed service identity to an ExpressRoute Port. |
Core | GA |
az network express-route port identity remove |
Remove the managed service identity of an ExpressRoute Port. |
Core | GA |
az network express-route port identity show |
Show the managed service identity of an ExpressRoute Port. |
Core | GA |
az network express-route port identity wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route port link |
View ExpressRoute links. |
Core | GA |
az network express-route port link list |
List ExpressRoute links. |
Core | GA |
az network express-route port link show |
Get the details of an ExpressRoute link. |
Core | GA |
az network express-route port link update |
Manage MACsec configuration of an ExpressRoute Link. |
Core | GA |
az network express-route port link wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route port list |
List ExpressRoute ports. |
Core | GA |
az network express-route port location |
View ExpressRoute port location information. |
Core | GA |
az network express-route port location list |
Get the details of an ExpressRoute port location. |
Core | GA |
az network express-route port location show |
Get a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location. |
Core | GA |
az network express-route port show |
Get the details of an ExpressRoute port. |
Core | GA |
az network express-route port update |
Update settings of an ExpressRoute port. |
Core | GA |
az network express-route port wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route show |
Get the details of an ExpressRoute circuit. |
Core | GA |
az network express-route update |
Update settings of an ExpressRoute circuit. |
Core | GA |
az network express-route wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network express-route create
Create an express route circuit.
az network express-route create --name
--resource-group
[--allow-classic-operations {0, 1, f, false, n, no, t, true, y, yes}]
[--allow-global-reach {0, 1, f, false, n, no, t, true, y, yes}]
[--bandwidth]
[--express-route-port]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--peering-location]
[--provider]
[--sku-family {MeteredData, UnlimitedData}]
[--sku-tier {Basic, Local, Premium, Standard}]
[--tags]
Examples
Create an ExpressRoute circuit.
az network express-route create --bandwidth 200 -n MyCircuit --peering-location "SiliconValley" -g MyResourceGroup --provider "Equinix" -l "West US" --sku-family MeteredData --sku-tier Standard
Required Parameters
ExpressRoute circuit name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Allow classic operations. Allowed values: false, true.
Enable global reach on the circuit.
Bandwidth of the circuit. Usage: INT {Mbps,Gbps}. Defaults to Mbps. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of an ExpressRoute port.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the long-running operation to finish.
Name of the peering location. Values from: az network express-route list-service-providers.
Name of the ExpressRoute Service Provider. Values from: az network express-route list-service-providers.
Chosen SKU family of ExpressRoute circuit. Allowed values: MeteredData, UnlimitedData. Default: MeteredData.
SKU Tier of ExpressRoute circuit. Allowed values: Basic, Local, Premium, Standard. Default: Standard.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 express-route delete
Delete an ExpressRoute circuit.
az network express-route delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Delete an ExpressRoute circuit.
az network express-route delete -n MyCircuit -g MyResourceGroup
Delete an ExpressRoute circuit. (autogenerated)
az network express-route delete --name MyCircuit --resource-group MyResourceGroup --subscription MySubscription
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.
ExpressRoute circuit 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 express-route get-stats
Get the statistics of an ExpressRoute circuit.
az network express-route get-stats [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get the statistics of an ExpressRoute circuit.
az network express-route get-stats -g MyResourceGroup -n MyCircuit
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.
ExpressRoute circuit 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 express-route list
List all ExpressRoute circuits for the current subscription.
az network express-route list [--max-items]
[--next-token]
[--resource-group]
Examples
List all ExpressRoute circuits for the current subscription.
az network express-route 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 express-route list-arp-tables
Show the current Address Resolution Protocol (ARP) table of an ExpressRoute circuit.
az network express-route list-arp-tables [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--path]
[--peering-name]
[--resource-group]
[--subscription]
Examples
Show the current Address Resolution Protocol (ARP) table of an ExpressRoute circuit.
az network express-route list-arp-tables -g MyResourceGroup -n MyCircuit --path primary --peering-name AzurePrivatePeering
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.
ExpressRoute circuit name.
Do not wait for the long-running operation to finish.
The path of the device. Allowed values: primary, secondary.
The name of the peering.
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 express-route list-route-tables
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show the current routing table of an ExpressRoute circuit peering.
az network express-route list-route-tables [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--path]
[--peering-name]
[--resource-group]
[--subscription]
Examples
Show the current routing table of an ExpressRoute circuit peering.
az network express-route list-route-tables -g MyResourceGroup -n MyCircuit --path primary --peering-name AzurePrivatePeering
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.
ExpressRoute circuit name.
Do not wait for the long-running operation to finish.
The path of the device. Allowed values: primary, secondary.
The name of the peering.
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 express-route list-route-tables-summary
This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Show the current routing table summary of an ExpressRoute circuit peering.
az network express-route list-route-tables-summary [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--path]
[--peering-name]
[--resource-group]
[--subscription]
Examples
List Route Table Summary
az network express-route list-route-tables-summary -g MyResourceGroup -n MyCircuit --path primary --peering-name AzurePrivatePeering
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.
ExpressRoute circuit name.
Do not wait for the long-running operation to finish.
The path of the device. Allowed values: primary, secondary.
The name of the peering.
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 express-route list-service-providers
List available ExpressRoute service providers.
az network express-route list-service-providers [--max-items]
[--next-token]
Examples
List available ExpressRoute service providers.
az network express-route list-service-providers
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.
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 express-route show
Get the details of an ExpressRoute circuit.
az network express-route show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get the details of an ExpressRoute circuit.
az network express-route 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.
ExpressRoute circuit 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 express-route update
Update settings of an ExpressRoute circuit.
az network express-route update [--add]
[--allow-classic-operations {0, 1, f, false, n, no, t, true, y, yes}]
[--allow-global-reach {0, 1, f, false, n, no, t, true, y, yes}]
[--bandwidth]
[--express-route-port]
[--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}]
[--peering-location]
[--provider]
[--remove]
[--resource-group]
[--set]
[--sku-family {MeteredData, UnlimitedData}]
[--sku-tier {Basic, Local, Premium, Standard}]
[--subscription]
[--tags]
Examples
Change the SKU of an ExpressRoute circuit from Standard to Premium.
az network express-route update -n MyCircuit -g MyResourceGroup --sku-tier Premium
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>
.
Allow classic operations.
Enable global reach on the circuit.
Bandwidth of the circuit. Usage: INT {Mbps,Gbps}. Defaults to Mbps. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name or ID of an ExpressRoute port.
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.
ExpressRoute circuit name.
Do not wait for the long-running operation to finish.
Name of the peering location.
Name of the ExpressRoute Service Provider.
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>
.
Chosen SKU family of ExpressRoute circuit. Allowed values: MeteredData, UnlimitedData.
SKU Tier of ExpressRoute circuit. Allowed values: Basic, Local, Premium, Standard.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 express-route wait
Place the CLI in a waiting state until a condition is met.
az network express-route 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.
ExpressRoute circuit 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.