az network vnet-gateway nat-rule
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
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/24Required Parameters
The private IP address external mapping for NAT. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Virtual network gateway name.
The private IP address internal mapping for NAT. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the resource that is unique within a resource group. This name can be used to access the resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
The IP Configuration ID this NAT rule applies to.
The Source NAT direction of a VPN NAT.
Do not wait for the long-running operation to finish.
The type of NAT rule for VPN NAT.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet-gateway nat-rule list
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-groupExamples
List nat rule
az network vnet-gateway nat-rule list --resource-group MyResourceGroup --gateway-name MyVnetGatewayRequired Parameters
Virtual network gateway name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet-gateway nat-rule remove
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 NatRequired Parameters
Virtual network gateway name.
The name of the resource that is unique within a resource group. This name can be used to access the resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network vnet-gateway nat-rule wait
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
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Virtual network gateway name.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
