az network express-route gateway

Manage ExpressRoute gateways.

Commands

Name	Description	Type	Status
az network express-route gateway connection	Manage ExpressRoute gateway connections.	Core	GA
az network express-route gateway connection create	Create an ExpressRoute gateway connection.	Core	GA
az network express-route gateway connection delete	Delete an ExpressRoute gateway connection.	Core	GA
az network express-route gateway connection list	List ExpressRoute gateway connections.	Core	GA
az network express-route gateway connection show	Get the details of an ExpressRoute gateway connection.	Core	GA
az network express-route gateway connection update	Update an ExpressRoute gateway connection.	Core	GA
az network express-route gateway connection wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az network express-route gateway create	Create an ExpressRoute gateway.	Core	GA
az network express-route gateway delete	Delete an ExpressRoute gateway.	Core	GA
az network express-route gateway list	List ExpressRoute gateways.	Core	GA
az network express-route gateway show	Get the details of an ExpressRoute gateway.	Core	GA
az network express-route gateway update	Update settings of an ExpressRoute gateway.	Core	GA
az network express-route gateway wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network express-route gateway create

Edit

Create an ExpressRoute gateway.

az network express-route gateway create --name
                                        --resource-group
                                        [--allow-non-vwan-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--location]
                                        [--max-val]
                                        [--min-val]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--tags]
                                        [--virtual-hub]

Examples

Create an ExpressRoute gateway.

az network express-route gateway create --name MyExpressRouteGateway --resource-group MyResourceGroup --min-val 5

Required Parameters

--name -n

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

--allow-non-vwan-traffic

Configures this gateway to accept traffic from non Virtual WAN networks.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--max-val

Maximum number of scale units deployed for gateway.

Property	Value
Parameter group:	Autoscale Arguments

--min-val

Minimum number of scale units deployed for gateway. Default: 2.

Property	Value
Parameter group:	Autoscale Arguments
Default value:	2

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

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

--virtual-hub

Name or ID of the virtual hub to associate with the gateway.

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

Edit

Delete an ExpressRoute gateway.

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

Examples

Delete an ExpressRoute gateway. (autogenerated)

az network express-route gateway delete --name MyExpressRouteGateway --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 gateway 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

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

Edit

List ExpressRoute gateways.

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

Examples

List ExpressRoute gateways. (autogenerated)

az network express-route gateway 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.

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

Edit

Get the details of an ExpressRoute gateway.

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

Examples

Get the details of an ExpressRoute gateway. (autogenerated)

az network express-route gateway show --name MyExpressRouteGateway --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 gateway 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 gateway update

Edit

Update settings of an ExpressRoute gateway.

az network express-route gateway update [--add]
                                        [--allow-non-vwan-traffic {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--location]
                                        [--max-val]
                                        [--min-val]
                                        [--name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--subscription]
                                        [--tags]
                                        [--virtual-hub]

Examples

Update an ExpressRoute gateway.

az network express-route gateway update --name MyExpressRouteGateway --resource-group MyResourceGroup --min-val 3

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

--allow-non-vwan-traffic

Configures this gateway to accept traffic from non Virtual WAN networks.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--max-val

Maximum number of scale units deployed for gateway.

Property	Value
Parameter group:	Autoscale Arguments

--min-val

Minimum number of scale units deployed for gateway. Default: 2.

Property	Value
Parameter group:	Autoscale Arguments

--name -n

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

--virtual-hub

Name or ID of the virtual hub to associate with the gateway.

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

Edit

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

az network express-route gateway 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 gateway 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 gateway

Commands

az network express-route gateway create

Examples

Required Parameters

Optional Parameters

az network express-route gateway delete

Examples

Optional Parameters

az network express-route gateway list

Examples

Optional Parameters

az network express-route gateway show

Examples

Optional Parameters

az network express-route gateway update

Examples

Optional Parameters

az network express-route gateway wait

Optional Parameters

Feedback