az network nat gateway

Commands to manage NAT gateways.

Commands

az network nat gateway create

Create a NAT gateway.

az network nat gateway delete

Delete a NAT gateway.

az network nat gateway list

List NAT gateways.

az network nat gateway show

Show details of a NAT gateway.

az network nat gateway update

Update a NAT gateway.

az network nat gateway wait

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

az network nat gateway create

Create a NAT gateway.

az network nat gateway create --name
                              --resource-group
                              [--idle-timeout]
                              [--location]
                              [--no-wait]
                              [--public-ip-addresses]
                              [--public-ip-prefixes]
                              [--subscription]
                              [--zone {1, 2, 3}]

Examples

Create a NAT gateway.

az network nat gateway create --resource-group MyResourceGroup --name MyNatGateway --location MyLocation --public-ip-addresses  MyPublicIp --public-ip-prefixes  MyPublicIpPrefix --idle-timeout 4 --zone 2

Required Parameters

--name -n

Name of the NAT gateway.

--resource-group -g

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

Optional Parameters

--idle-timeout

Idle timeout in minutes.

--location -l

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

--no-wait

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

--public-ip-addresses

Space-separated list of public IP addresses (names or IDs).

--public-ip-prefixes

Space-separated list of public IP prefixes (names or IDs).

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--zone -z

Availability zone into which to provision the resource.

accepted values: 1, 2, 3

az network nat gateway delete

Delete a NAT gateway.

az network nat gateway delete [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Examples

Delete a NAT gateway.

az network nat gateway delete --resource-group MyResourceGroup --name MyNatGateway

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

Name of the NAT gateway.

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

az network nat gateway list

List NAT gateways.

az network nat gateway list [--query-examples]
                            [--resource-group]
                            [--subscription]

Examples

List NAT gateways.

az network nat gateway list -g MyResourceGroup

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

az network nat gateway show

Show details of a NAT gateway.

az network nat gateway show [--ids]
                            [--name]
                            [--query-examples]
                            [--resource-group]
                            [--subscription]

Examples

Show details of a NAT gateway.

az network nat gateway show --resource-group MyResourceGroup --name MyNatGateway

Show NAT gateway using ID.

az network nat gateway show --ids {GatewayId}

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

Name of the NAT gateway.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

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

az network nat gateway update

Update a NAT gateway.

az network nat gateway update [--add]
                              [--force-string]
                              [--idle-timeout]
                              [--ids]
                              [--name]
                              [--public-ip-addresses]
                              [--public-ip-prefixes]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]

Examples

Update a NAT gateway.

az network nat gateway update -g MyResourceGroup --name MyNatGateway --idle-timeout 5

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.

--idle-timeout

Idle timeout in minutes.

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

Name of the NAT gateway.

--public-ip-addresses

Space-separated list of public IP addresses (names or IDs).

--public-ip-prefixes

Space-separated list of public IP prefixes (names or IDs).

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az network nat gateway wait

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

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

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

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

Name of the NAT gateway.

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