az network express-route port

  • Reference

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

Edit

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

ExpressRoute port name.

--resource-group -g

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

Optional Parameters

--bandwidth

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

The billing type of the ExpressRoutePort resource.

accepted values: MeteredData, UnlimitedData
--encapsulation

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

accepted values: Dot1Q, QinQ
--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.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--peering-location

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

--tags

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az network express-route port delete

Edit

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

Optional Parameters

--ids

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

ExpressRoute port name.

--no-wait

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

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.

--yes -y

Do not prompt for confirmation.

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az network express-route port generate-loa

Edit

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]

Required Parameters

--customer-name

The customer name.

Optional Parameters

--file -f

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

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az network express-route port list

Edit

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

Optional Parameters

--max-items

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

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

--resource-group -g

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az network express-route port show

Edit

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

Optional Parameters

--ids

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az network express-route port update

Edit

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

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

--billing-type

The billing type of the ExpressRoutePort resource.

accepted values: MeteredData, UnlimitedData
--force-string

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

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

ExpressRoute port name.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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=.

--subscription

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

--tags

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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

az network express-route port wait

Edit

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]

Optional Parameters

--created

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

default value: False
--custom

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

--deleted

Wait until deleted.

default value: False
--exists

Wait until the resource exists.

default value: False
--ids

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

Polling interval in seconds.

default value: 30
--name -n

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

default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

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

--subscription

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

--verbose

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