az network vnet-gateway nat-rule

  • Reference

Manage nat rule in a virtual network gateway.

Commands

Name Description Type Status
az network vnet-gateway nat-rule add

Add nat rule in a virtual network gateway.

 Core Preview
az network vnet-gateway nat-rule list

List nat rule for a virtual network gateway.

 Core Preview
az network vnet-gateway nat-rule remove

Remove nat rule from a virtual network gateway.

 Core Preview
az network vnet-gateway nat-rule wait

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

 Core GA

az network vnet-gateway nat-rule add

Edit
Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add nat rule in a virtual network gateway.

az network vnet-gateway nat-rule add --external-mappings
                                     --gateway-name
                                     --internal-mappings
                                     --name
                                     --resource-group
                                     [--ip-config-id]
                                     [--mode {EgressSnat, IngressSnat}]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--type {Dynamic, Static}]

Examples

Add nat rule

az network vnet-gateway nat-rule add --resource-group MyResourceGroup --gateway-name MyVnetGateway --name Nat --internal-mappings 10.4.0.0/24 --external-mappings 192.168.21.0/24

Required Parameters

--external-mappings

The private IP address external mapping for NAT. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--gateway-name

Virtual network gateway name.

--internal-mappings

The private IP address internal mapping for NAT. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name

The name of the resource that is unique within a resource group. This name can be used to access the resource.

--resource-group -g

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

Optional Parameters

--ip-config-id

The IP Configuration ID this NAT rule applies to.

--mode

The Source NAT direction of a VPN NAT.

accepted values: EgressSnat, IngressSnat
--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--type

The type of NAT rule for VPN NAT.

accepted values: Dynamic, Static
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 vnet-gateway nat-rule list

Edit
Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List nat rule for a virtual network gateway.

az network vnet-gateway nat-rule list --gateway-name
                                      --resource-group

Examples

List nat rule

az network vnet-gateway nat-rule list --resource-group MyResourceGroup --gateway-name MyVnetGateway

Required Parameters

--gateway-name

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

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 vnet-gateway nat-rule remove

Edit
Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove nat rule from a virtual network gateway.

az network vnet-gateway nat-rule remove --gateway-name
                                        --name
                                        --resource-group
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Remove nat rule

az network vnet-gateway nat-rule remove --resource-group MyResourceGroup --gateway-name MyVnetGateway --name Nat

Required Parameters

--gateway-name

Virtual network gateway name.

--name

The name of the resource that is unique within a resource group. This name can be used to access the resource.

--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 vnet-gateway nat-rule wait

Edit

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

az network vnet-gateway nat-rule wait [--created]
                                      [--custom]
                                      [--deleted]
                                      [--exists]
                                      [--gateway-name]
                                      [--ids]
                                      [--interval]
                                      [--resource-group]
                                      [--subscription]
                                      [--timeout]
                                      [--updated]

Optional Parameters

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

Virtual network gateway 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.

--interval

Polling interval in seconds.

default value: 30
--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.