az network express-route port

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage ExpressRoute ports.

Commands

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 generate-loa	Generate and download a letter of authorization for the requested ExpressRoutePort.
az network express-route port identity	Manage the managed service identity of an ExpressRoute Port.
az network express-route port identity assign	Assign a managed service identity to an ExpressRoute Port.
az network express-route port identity remove	Remove the managed service identity of an ExpressRoute Port.
az network express-route port identity show	Show the managed service identity of 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 link update	Manage MACsec configuration 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 port create

Create an ExpressRoute port.

az network express-route port create --name
                                     --resource-group
                                     [--bandwidth]
                                     [--encapsulation {Dot1Q, QinQ}]
                                     [--location]
                                     [--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 Gbps.

--encapsulation

Encapsulation method on physical ports.

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

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

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.

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

Delete an ExpressRoute port.

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

Examples

Delete an ExpressRoute port. (autogenerated)

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.

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

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

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]

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

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.

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

List ExpressRoute ports.

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

Examples

List ExpressRoute ports. (autogenerated)

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

Optional Parameters

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

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

Get the details of an ExpressRoute port.

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

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

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.

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

Update settings of an ExpressRoute port.

az network express-route port update [--add]
                                     [--force-string]
                                     [--ids]
                                     [--name]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--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>.

--force-string

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

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

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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.

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