az network express-route port link

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.

View ExpressRoute links.

Commands

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

List ExpressRoute links.

az network express-route port link list --port-name
                                        --resource-group

Examples

List ExpressRoute links. (autogenerated)

az network express-route port link list --port-name MyPort --resource-group MyResourceGroup

Required Parameters

--port-name

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

Get the details of an ExpressRoute link.

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

Examples

Get the details of an ExpressRoute link. (autogenerated)

az network express-route port link show --name MyLinkExpressRoutePort --port-name MyPort --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

The link name of the ExpressRoute Port.

--port-name

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

Manage MACsec configuration of an ExpressRoute Link.

az network express-route port link update [--add]
                                          [--admin-state {Disabled, Enabled}]
                                          [--force-string]
                                          [--ids]
                                          [--macsec-cak-secret-identifier]
                                          [--macsec-cipher {GcmAes128, GcmAes256, GcmAesXpn128, GcmAesXpn256}]
                                          [--macsec-ckn-secret-identifier]
                                          [--macsec-sci-state {Disabled, Enabled}]
                                          [--name]
                                          [--no-wait]
                                          [--port-name]
                                          [--remove]
                                          [--resource-group]
                                          [--set]

Examples

Enable MACsec on ExpressRoute Direct Ports once at a time.

az network express-route port link update \
--resource-group MyResourceGroup \
--port-name MyExpressRoutePort \
--name link1 \
--macsec-ckn-secret-identifier MacSecCKNSecretID \
--macsec-cak-secret-identifier MacSecCAKSecretID \
--macsec-cipher GcmAes128

Enable administrative state of an ExpressRoute Link.

az network express-route port link update \
--resource-group MyResourceGroup \
--port-name MyExpressRoutePort \
--name link2 \
--admin-state Enabled

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

--admin-state

Enable/Disable administrative state of an ExpressRoute Link.

accepted values: Disabled, Enabled

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

--macsec-cak-secret-identifier

The connectivity association key (CAK) ID that stored in the KeyVault.

--macsec-cipher

Cipher Method.

accepted values: GcmAes128, GcmAes256, GcmAesXpn128, GcmAesXpn256

--macsec-ckn-secret-identifier

The connectivity key name (CKN) that stored in the KeyVault.

--macsec-sci-state

Sci mode.

accepted values: Disabled, Enabled

--name -n

The link name of the ExpressRoute Port.

--no-wait

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

--port-name

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

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.