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

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	MeteredData, UnlimitedData

--encapsulation

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

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

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

ExpressRoute port name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	loa.pdf

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

ExpressRoute port name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

Property	Value
Parameter group:	Pagination Arguments

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

ExpressRoute port name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--billing-type

The billing type of the ExpressRoutePort resource.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	MeteredData, UnlimitedData

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

ExpressRoute port name.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
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 <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name -n

ExpressRoute port name.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

Share via

az network express-route port

Commands

az network express-route port create

Examples

Required Parameters

Optional Parameters

az network express-route port delete

Examples

Optional Parameters

az network express-route port generate-loa

Required Parameters

Optional Parameters

az network express-route port list

Examples

Optional Parameters

az network express-route port show

Examples

Optional Parameters

az network express-route port update

Examples

Optional Parameters

az network express-route port wait

Optional Parameters

Feedback