Express Route - az network express-route

Manage dedicated private network fiber connections to Azure.

Commands

az network express-route auth Manage authentication of an ExpressRoute circuit.
az network express-route auth create Create an authorization setting.
az network express-route auth delete Delete an authorization setting.
az network express-route auth list List authorization settings.
az network express-route auth show Show details of an authorization setting.
az network express-route create Create an ExpressRoute circuit.
az network express-route delete Delete an ExpressRoute circuit.
az network express-route get-stats Show statistics of an ExpressRoute circuit.
az network express-route list List ExpressRoute circuits.
az network express-route list-arp-tables List the currently advertised ARP table of an ExpressRoute circuit.
az network express-route list-route-tables List the currently advertised route tables of an ExpressRoute circuit.
az network express-route list-service-providers List available ExpressRoute service providers.
az network express-route peering Manage ExpressRoute peering.
az network express-route peering create Create peering settings.
az network express-route peering delete Delete peering settings.
az network express-route peering list List peering settings.
az network express-route peering show Show peering details.
az network express-route peering update Update peering settings.
az network express-route show Show details of an ExpressRoute circuit.
az network express-route update Update settings of an ExpressRoute circuit.
az network express-route wait

az network express-route create

Create an ExpressRoute circuit.

az network express-route create --bandwidth
--name
--peering-location
--provider
--resource-group
[--location]
[--no-wait]
[--sku-family {MeteredData, UnlimitedData}]
[--sku-tier {Premium, Standard}]
[--tags]

Required Parameters

--bandwidth

Bandwidth in Mbps of the circuit. It must exactly match one of the available bandwidth offers from the 'list-service-providers' command.

--name -n

ExpressRoute circuit name.

--peering-location

Name of the peering location. It must exactly match one of the available peering locations from the 'list-service-providers' command.

--provider

Name of the ExpressRoute Service Provider. It must exactly match one of the Service Providers from the 'list-service-providers' command.

--resource-group -g

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

Optional Parameters

--location -l

Location. You can configure the default location using az configure --defaults 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: Premium, Standard
default value: Standard
--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 --name
--resource-group
[--no-wait]

Required Parameters

--name -n

ExpressRoute circuit name.

--resource-group -g

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

Optional Parameters

--no-wait

Do not wait for the long running operation to finish.

az network express-route get-stats

Show statistics of an ExpressRoute circuit.

az network express-route get-stats --name
--resource-group

Required Parameters

--name -n

ExpressRoute circuit name.

--resource-group -g

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

az network express-route list

List ExpressRoute circuits.

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

Optional Parameters

--resource-group -g

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

az network express-route list-arp-tables

List the currently advertised ARP table of an ExpressRoute circuit.

az network express-route list-arp-tables --name
--path {primary, secondary}
--peering-name
--resource-group

Required Parameters

--name -n

ExpressRoute circuit name.

--path

The path of the device.

accepted values: primary, secondary
--peering-name

The name of the peering.

--resource-group -g

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

az network express-route list-route-tables

List the currently advertised route tables of an ExpressRoute circuit.

az network express-route list-route-tables --name
--path {primary, secondary}
--peering-name
--resource-group

Required Parameters

--name -n

ExpressRoute circuit name.

--path

The path of the device.

accepted values: primary, secondary
--peering-name

The name of the peering.

--resource-group -g

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

az network express-route list-service-providers

List available ExpressRoute service providers.

az network express-route list-service-providers

az network express-route show

Show details of an ExpressRoute circuit.

az network express-route show --name
--resource-group

Required Parameters

--name -n

ExpressRoute circuit name.

--resource-group -g

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

az network express-route update

Update settings of an ExpressRoute circuit.

az network express-route update --name
--resource-group
[--add]
[--bandwidth]
[--no-wait]
[--peering-location]
[--provider]
[--remove]
[--set]
[--sku-family {MeteredData, UnlimitedData}]
[--sku-tier {Premium, Standard}]
[--tags]

Required Parameters

--name -n

ExpressRoute circuit name.

--resource-group -g

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

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .

--bandwidth

Bandwidth in Mbps of the circuit. It must exactly match one of the available bandwidth offers from the 'list-service-providers' command.

--no-wait

Do not wait for the long running operation to finish.

--peering-location

Name of the peering location. It must exactly match one of the available peering locations from the 'list-service-providers' command.

--provider

Name of the ExpressRoute Service Provider. It must exactly match one of the Service Providers from the 'list-service-providers' command.

--remove

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

--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: Premium, Standard
--tags

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

az network express-route wait

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

Required Parameters

--name -n

ExpressRoute circuit name.

--resource-group -g

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

Optional Parameters

--created

Wait till 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 till deleted.

--exists

Wait till the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait till updated with provisioningState at 'Succeeded'.