az network firewall nat-rule

Note

This reference is part of the azure-firewall extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az network firewall nat-rule command. Learn more about extensions.

Manage and configure Azure Firewall NAT rules.

Commands

Name	Description	Type	Status
az network firewall nat-rule collection	Manage and configure Azure Firewall NAT rules.	Extension	GA
az network firewall nat-rule collection delete	Delete an Azure Firewall NAT rule collection.	Extension	GA
az network firewall nat-rule collection list	List Azure Firewall NAT rule collections.	Extension	GA
az network firewall nat-rule collection show	Get the details of an Azure Firewall NAT rule collection.	Extension	GA
az network firewall nat-rule create	Create an Azure Firewall NAT rule.	Extension	GA
az network firewall nat-rule delete	Delete an Azure Firewall NAT rule.	Extension	GA
az network firewall nat-rule list	List Azure Firewall NAT rules.	Extension	GA
az network firewall nat-rule show	Get the details of an Azure Firewall NAT rule.	Extension	GA

az network firewall nat-rule create

Create an Azure Firewall NAT rule.

az network firewall nat-rule create --collection-name
                                    --dest-addr
                                    --destination-ports
                                    --firewall-name
                                    --name
                                    --protocols {Any, ICMP, TCP, UDP}
                                    --resource-group
                                    --translated-port
                                    [--action {Dnat, Snat}]
                                    [--description]
                                    [--priority]
                                    [--source-addresses]
                                    [--source-ip-groups]
                                    [--translated-address]
                                    [--translated-fqdn]

Required Parameters

--collection-name -c

Name of the collection to create the rule in. Will create the collection if it does not exist.

--dest-addr --destination-addresses

Space-separated list of destination IP addresses. Use '*' to match all.

--destination-ports

Space-separated list of destination ports. Use '*' to match all.

--firewall-name -f

Azure Firewall name.

--name -n

The name of the NAT rule.

--protocols

Space-separated list of protocols.

Accepted values: Any, ICMP, TCP, UDP

--resource-group -g

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

--translated-port

Translated port for this NAT rule.

Optional Parameters

--action

The action to apply for the rule collection. Supply only if you want to create the collection.

Accepted values: Dnat, Snat

--description

Rule description.

--priority

Priority of the rule collection from 100 (high) to 65000 (low). Supply only if you want to create the collection.

--source-addresses

Space-separated list of source IP addresses. Use '*' to match all.

--source-ip-groups

Space-separated list of name or resource id of source IpGroups.

--translated-address

Translated address for this NAT rule.

--translated-fqdn

Translated FQDN for this NAT rule.

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 firewall nat-rule delete

Delete an Azure Firewall NAT rule.

az network firewall nat-rule delete [--collection-name]
                                    [--firewall-name]
                                    [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

Optional Parameters

--collection-name -c

Name of the rule collection.

--firewall-name -f

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

--name -n

The name of the NAT rule.

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

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 firewall nat-rule list

List Azure Firewall NAT rules.

az network firewall nat-rule list --collection-name
                                  --firewall-name
                                  --resource-group

Required Parameters

--collection-name -c

Name of the rule collection.

--firewall-name -f

Azure Firewall 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 firewall nat-rule show

Get the details of an Azure Firewall NAT rule.

az network firewall nat-rule show [--collection-name]
                                  [--firewall-name]
                                  [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Optional Parameters

--collection-name -c

Name of the rule collection.

--firewall-name -f

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

--name -n

The name of the NAT rule.

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

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.