az network express-route auth

  • Reference

Manage authentication of an ExpressRoute circuit.

To learn more about ExpressRoute circuit authentication visit https://docs.microsoft.com/azure/expressroute/howto-linkvnet-cli#connect-a-virtual-network-in-a-different-subscription-to-a-circuit.

Commands

Name Description Type Status
az network express-route auth create

Create a new link authorization for an ExpressRoute circuit.

 Core GA
az network express-route auth delete

Delete a link authorization of an ExpressRoute circuit.

 Core GA
az network express-route auth list

List link authorizations of an ExpressRoute circuit.

 Core GA
az network express-route auth show

Get the details of a link authorization of an ExpressRoute circuit.

 Core GA
az network express-route auth wait

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

 Core GA

az network express-route auth create

Edit

Create a new link authorization for an ExpressRoute circuit.

az network express-route auth create --circuit-name
                                     --name
                                     --resource-group
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create a new link authorization for an ExpressRoute circuit.

az network express-route auth create --circuit-name MyCircuit -g MyResourceGroup -n MyAuthorization

Required Parameters

--circuit-name

ExpressRoute circuit name.

--name -n

Authorization name.

--resource-group -g

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

Optional Parameters

--no-wait

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

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

Edit

Delete a link authorization of an ExpressRoute circuit.

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

Examples

Delete a link authorization of an ExpressRoute circuit.

az network express-route auth delete --circuit-name MyCircuit -g MyResourceGroup -n MyAuthorization

Optional Parameters

--circuit-name

ExpressRoute circuit name.

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

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

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

Edit

List link authorizations of an ExpressRoute circuit.

az network express-route auth list --circuit-name
                                   --resource-group

Examples

List link authorizations of an ExpressRoute circuit.

az network express-route auth list -g MyResourceGroup --circuit-name MyCircuit

List link authorizations of an ExpressRoute circuit. (autogenerated)

az network express-route auth list --circuit-name MyCircuit --resource-group MyResourceGroup --subscription MySubscription

Required Parameters

--circuit-name

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

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

Edit

Get the details of a link authorization of an ExpressRoute circuit.

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

Examples

Get the details of a link authorization of an ExpressRoute circuit.

az network express-route auth show -g MyResourceGroup --circuit-name MyCircuit -n MyAuthorization

Optional Parameters

--circuit-name

ExpressRoute circuit name.

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

Authorization 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 auth wait

Edit

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

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

Optional Parameters

--circuit-name

ExpressRoute circuit name.

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

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