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

az network express-route create

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

List all ExpressRoute circuits for the current subscription.

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 create

Create an ExpressRoute circuit.

az network express-route create --bandwidth
                                --name
                                --resource-group
                                [--allow-global-reach {false, true}]
                                [--express-route-port]
                                [--location]
                                [--no-wait]
                                [--peering-location]
                                [--provider]
                                [--sku-family {MeteredData, UnlimitedData}]
                                [--sku-tier {Premium, Standard}]
                                [--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.

--resource-group -g

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

Optional Parameters

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

--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
--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: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az network express-route list

List all ExpressRoute circuits for the current subscription.

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

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

az network express-route show

Get the details of an ExpressRoute circuit.

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

Examples

Get the details of an ExpressRoute circuit.

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

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

az network express-route update

Update settings of an ExpressRoute circuit.

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

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

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

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

--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: key[=value] [key[=value] ...]. Use "" to clear existing tags.