Share via


az network express-route port

Manage ExpressRoute ports.

Commands

Name Description Type Status
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 port create

Experimental Preview Deprecated

Create an ExpressRoute port.

az network express-route port create --name
                                     --resource-group
                                     [--bandwidth]
                                     [--billing-type {MeteredData, UnlimitedData}]
                                     [--encapsulation {Dot1Q, QinQ}]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--peering-location]
                                     [--tags]

Examples

Create an ExpressRoute port. (autogenerated)

az network express-route port create --bandwidth 200 --encapsulation Dot1Q --location westus2 --name MyExpressRoutePort --peering-location westus --resource-group MyResourceGroup

Required Parameters

--name -n
Experimental Preview Deprecated

ExpressRoute port name.

--resource-group -g
Experimental Preview Deprecated

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

Optional Parameters

--bandwidth
Experimental Preview Deprecated

Bandwidth of the circuit. Usage: INT {Mbps,Gbps}. Defaults to Mbps. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--billing-type
Experimental Preview Deprecated

The billing type of the ExpressRoutePort resource.

Accepted values: MeteredData, UnlimitedData
--encapsulation
Experimental Preview Deprecated

Encapsulation method on physical ports. Allowed values: Dot1Q, QinQ.

Accepted values: Dot1Q, QinQ
--location -l
Experimental Preview Deprecated

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

--no-wait
Experimental Preview Deprecated

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--peering-location
Experimental Preview Deprecated

The name of the peering location that the port is mapped to physically.

--tags
Experimental Preview Deprecated

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
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az network express-route port delete

Experimental Preview Deprecated

Delete an ExpressRoute port.

az network express-route port delete [--ids]
                                     [--name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Examples

Delete an ExpressRoute port.

az network express-route port delete --name MyExpressRoutePort --resource-group MyResourceGroup

Required Parameters

Optional Parameters

--ids
Experimental Preview Deprecated

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.

--name -n
Experimental Preview Deprecated

ExpressRoute port name.

--no-wait
Experimental Preview Deprecated

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--yes -y
Experimental Preview Deprecated

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az network express-route port generate-loa

Experimental Preview Deprecated

Generate and download a letter of authorization for the requested ExpressRoutePort.

az network express-route port generate-loa --customer-name
                                           [--file]
                                           [--ids]
                                           [--name]
                                           [--resource-group]
                                           [--subscription]

Examples

Required Parameters

--customer-name
Experimental Preview Deprecated

The customer name.

Optional Parameters

--file -f
Experimental Preview Deprecated

Directory or the file path of the letter to be saved to. If the file name extension is not .pdf, Azure CLI will help to append. Be careful, the existing file might get overwritten.

Default value: loa.pdf
--ids
Experimental Preview Deprecated

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.

--name -n
Experimental Preview Deprecated

ExpressRoute port name.

--resource-group -g
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az network express-route port list

Experimental Preview Deprecated

List ExpressRoute ports.

az network express-route port list [--max-items]
                                   [--next-token]
                                   [--resource-group]

Examples

List ExpressRoute ports. (autogenerated)

az network express-route port list --resource-group myresourcegroup

Required Parameters

Optional Parameters

--max-items
Experimental Preview Deprecated

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.

--next-token
Experimental Preview Deprecated

Token to specify where to start paginating. This is the token value from a previously truncated response.

--resource-group -g
Experimental Preview Deprecated

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

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az network express-route port show

Experimental Preview Deprecated

Get the details of an ExpressRoute port.

az network express-route port show [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]

Examples

Get the details of an ExpressRoute port. (autogenerated)

az network express-route port show --name MyExpressRoutePort --resource-group MyResourceGroup

Required Parameters

Optional Parameters

--ids
Experimental Preview Deprecated

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.

--name -n
Experimental Preview Deprecated

ExpressRoute port name.

--resource-group -g
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az network express-route port update

Experimental Preview Deprecated

Update settings of an ExpressRoute port.

az network express-route port update [--add]
                                     [--billing-type {MeteredData, UnlimitedData}]
                                     [--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}]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--subscription]
                                     [--tags]

Examples

Update settings of an ExpressRoute port (autogenerated)

az network express-route port update --name MyExpressRoutePort --resource-group MyResourceGroup

Required Parameters

Optional Parameters

--add
Experimental Preview Deprecated

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

--billing-type
Experimental Preview Deprecated

The billing type of the ExpressRoutePort resource.

Accepted values: MeteredData, UnlimitedData
--force-string
Experimental Preview Deprecated

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids
Experimental Preview Deprecated

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.

--name -n
Experimental Preview Deprecated

ExpressRoute port name.

--no-wait
Experimental Preview Deprecated

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove
Experimental Preview Deprecated

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

--resource-group -g
Experimental Preview Deprecated

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

--set
Experimental Preview Deprecated

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription
Experimental Preview Deprecated

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

--tags
Experimental Preview Deprecated

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
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.

az network express-route port wait

Experimental Preview Deprecated

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

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

Examples

Required Parameters

Optional Parameters

--created
Experimental Preview Deprecated

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

Default value: False
--custom
Experimental Preview Deprecated

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

--deleted
Experimental Preview Deprecated

Wait until deleted.

Default value: False
--exists
Experimental Preview Deprecated

Wait until the resource exists.

Default value: False
--ids
Experimental Preview Deprecated

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.

--interval
Experimental Preview Deprecated

Polling interval in seconds.

Default value: 30
--name -n
Experimental Preview Deprecated

ExpressRoute port name.

--resource-group -g
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--timeout
Experimental Preview Deprecated

Maximum wait in seconds.

Default value: 3600
--updated
Experimental Preview Deprecated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

Increase logging verbosity. Use --debug for full debug logs.