az network express-route gateway

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

Commands

az network express-route gateway connection	Manage ExpressRoute gateway connections.
az network express-route gateway connection create	Create an ExpressRoute gateway connection.
az network express-route gateway connection delete	Delete an ExpressRoute gateway connection.
az network express-route gateway connection list	List ExpressRoute gateway connections.
az network express-route gateway connection show	Get the details of an ExpressRoute gateway connection.
az network express-route gateway connection update	Update an ExpressRoute gateway connection.
az network express-route gateway create	Create an ExpressRoute gateway.
az network express-route gateway delete	Delete an ExpressRoute gateway.
az network express-route gateway list	List ExpressRoute gateways.
az network express-route gateway show	Get the details of an ExpressRoute gateway.
az network express-route gateway update	Update settings of an ExpressRoute gateway.

az network express-route gateway create

Create an ExpressRoute gateway.

az network express-route gateway create --name
                                        --resource-group
                                        [--location]
                                        [--max-val]
                                        [--min-val]
                                        [--tags]
                                        [--virtual-hub]

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

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

--min-val

Minimum number of scale units deployed for gateway.

default value: 2

--tags

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

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

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

Delete an ExpressRoute gateway.

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

Examples

Delete an ExpressRoute gateway. (autogenerated)

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

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

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

Get the details of an ExpressRoute gateway.

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

Examples

Get the details of an ExpressRoute gateway. (autogenerated)

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

Update settings of an ExpressRoute gateway.

az network express-route gateway update [--add]
                                        [--force-string]
                                        [--ids]
                                        [--max-val]
                                        [--min-val]
                                        [--name]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--tags]

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.

--max-val

Maximum number of scale units deployed for gateway.

--min-val

Minimum number of scale units deployed for gateway.

--name -n

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