az network express-route

Manage dedicated private network fiber connections to Azure.

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

Commands

az network express-route auth Manage authentication of an ExpressRoute circuit.
az network express-route auth create Create a new link authorization for an ExpressRoute circuit.
az network express-route auth delete Delete a link authorization of an ExpressRoute circuit.
az network express-route auth list List link authorizations of an ExpressRoute circuit.
az network express-route auth show Get the details of a link authorization of an ExpressRoute circuit.
az network express-route create Create an ExpressRoute circuit.
az network express-route delete Delete an ExpressRoute circuit.
az network express-route gateway Manage ExpressRoute gateways.
az network express-route gateway connection Manage ExpressRoute gateway connections.
az network express-route gateway connection create Create an ExpressRoute gateway connection.
az network express-route gateway connection delete Delete an ExpressRoute gateway connection.
az network express-route gateway connection list List ExpressRoute gateway connections.
az network express-route gateway connection show Get the details of an ExpressRoute gateway connection.
az network express-route gateway connection update Update an ExpressRoute gateway connection.
az network express-route gateway create Create an ExpressRoute gateway.
az network express-route gateway delete Delete an ExpressRoute gateway.
az network express-route gateway list List ExpressRoute gateways.
az network express-route gateway show Get the details of an ExpressRoute gateway.
az network express-route gateway update Update settings of an ExpressRoute gateway.
az network express-route get-stats Get the statistics of an ExpressRoute circuit.
az network express-route list List all ExpressRoute circuits for the current subscription.
az network express-route list-arp-tables Show the current Address Resolution Protocol (ARP) table of an ExpressRoute circuit.
az network express-route list-route-tables Show the current routing table of an ExpressRoute circuit peering.
az network express-route list-service-providers List available ExpressRoute service providers.
az network express-route peering Manage ExpressRoute peering of an ExpressRoute circuit.
az network express-route peering connection Manage ExpressRoute circuit connections.
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 show Get the details of an ExpressRoute circuit connection.
az network express-route peering create Create peering settings for an ExpressRoute circuit.
az network express-route peering delete Delete peering settings.
az network express-route peering list List peering settings of an ExpressRoute circuit.
az network express-route peering show Get the details of an express route peering.
az network express-route peering update Update peering settings of an ExpressRoute circuit.
az network express-route port Manage ExpressRoute ports.
az network express-route port create Create an ExpressRoute port.
az network express-route port delete Delete an ExpressRoute port.
az network express-route port link View ExpressRoute links.
az network express-route port link list List ExpressRoute links.
az network express-route port link show Get the details of an ExpressRoute link.
az network express-route port list List ExpressRoute ports.
az network express-route port location View ExpressRoute port location information.
az network express-route port location list List ExpressRoute port locations.
az network express-route port location show Get the details of an ExpressRoute port location.
az network express-route port show Get the details of an ExpressRoute port.
az network express-route port update Update settings of an ExpressRoute port.
az network express-route show Get the details of an ExpressRoute circuit.
az network express-route update Update settings of an ExpressRoute circuit.
az network express-route wait Place the CLI in a waiting state until a condition of the ExpressRoute is met.

az network express-route create

Create an ExpressRoute circuit.

az network express-route create --bandwidth
--name
--peering-location
--provider
--resource-group
[--allow-classic-operations {false, true}]
[--allow-global-reach {false, true}]
[--express-route-port]
[--location]
[--no-wait]
[--sku-family {MeteredData, UnlimitedData}]
[--sku-tier {Basic, Premium, Standard}]
[--subscription]
[--tags]

Examples

Create an ExpressRoute circuit.

az network express-route create --bandwidth 200 -n MyCircuit --peering-location "Silicon Valley" -g MyResourceGroup --provider "Equinix" -l "West US" --sku-family MeteredData --sku-tier Standard

Required Parameters

--bandwidth

Bandwidth of the circuit. Usage: INT {Mbps,Gbps}. Defaults to Mbps.

value from: az network express-route list-service-providers
--name -n

ExpressRoute circuit name.

--peering-location

Name of the peering location.

value from: az network express-route list-service-providers
--provider

Name of the ExpressRoute Service Provider.

value from: az network express-route list-service-providers
--resource-group -g

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

Optional Parameters

--allow-classic-operations

Allow classic operations.

accepted values: false, true
--allow-global-reach

Enable global reach on the circuit.

accepted values: false, true
--express-route-port

Name or ID of an ExpressRoute port.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

--sku-family

Chosen SKU family of ExpressRoute circuit.

accepted values: MeteredData, UnlimitedData
default value: MeteredData
--sku-tier

SKU Tier of ExpressRoute circuit.

accepted values: Basic, Premium, Standard
default value: Standard
--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

az network express-route delete

Delete an ExpressRoute circuit.

az network express-route delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]

Examples

Delete an ExpressRoute circuit.

az network express-route delete -n MyCircuit -g MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

ExpressRoute circuit name.

--no-wait

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

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

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

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

az network express-route list

List all ExpressRoute circuits for the current subscription.

az network express-route list [--resource-group]
[--subscription]

Examples

List all ExpressRoute circuits for the current subscription.

az network express-route list -g MyResourceGroup

Optional Parameters

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

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 --path {primary, secondary}
--peering-name
[--ids]
[--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

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). If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

az network express-route list-route-tables

Show the current routing table of an ExpressRoute circuit peering.

az network express-route list-route-tables --path {primary, secondary}
--peering-name
[--ids]
[--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

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). If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

az network express-route list-service-providers

List available ExpressRoute service providers.

az network express-route list-service-providers [--subscription]

Examples

List available ExpressRoute service providers.

az network express-route list-service-providers

Optional Parameters

--subscription

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

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

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

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

az network express-route update

Update settings of an ExpressRoute circuit.

az network express-route update [--add]
[--allow-classic-operations {false, true}]
[--allow-global-reach {false, true}]
[--bandwidth]
[--express-route-port]
[--force-string]
[--ids]
[--name]
[--no-wait]
[--peering-location]
[--provider]
[--remove]
[--resource-group]
[--set]
[--sku-family {MeteredData, UnlimitedData}]
[--sku-tier {Basic, 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

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

Allow classic operations.

accepted values: false, true
--allow-global-reach

Enable global reach on the circuit.

accepted values: false, true
--bandwidth

Bandwidth of the circuit. Usage: INT {Mbps,Gbps}. Defaults to Mbps.

--express-route-port

Name or ID of an ExpressRoute port.

--force-string

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

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

ExpressRoute circuit name.

--no-wait

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

--peering-location

Name of the peering location.

--provider

Name of the ExpressRoute Service Provider.

--remove

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

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

--sku-family

Chosen SKU family of ExpressRoute circuit.

accepted values: MeteredData, UnlimitedData
--sku-tier

SKU Tier of ExpressRoute circuit.

accepted values: Basic, Premium, Standard
--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

az network express-route wait

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

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

Examples

Pause executing next line of CLI script until the ExpressRoute circuit is successfully provisioned.

az network express-route wait -n MyCircuit -g MyResourceGroup --created

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--interval

Polling interval in seconds.

default value: 30
--name -n

ExpressRoute circuit 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'.