Share via

az network firewall nat-rule collection

Note

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

Manage and configure Azure Firewall NAT rules.

Collections are created as part of the az network firewall nat-rule create command.

Commands

Name Description Type Status
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 collection delete

Delete an Azure Firewall NAT rule collection.

az network firewall nat-rule collection delete [--acquire-policy-token]
                                               [--change-reference]
                                               [--collection-name]
                                               [--firewall-name]
                                               [--ids]
                                               [--resource-group]
                                               [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--collection-name -c

Name of the rule collection.

Property Value
Parameter group: Resource Id Arguments
--firewall-name -f

Azure Firewall name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az network firewall nat-rule collection list

List Azure Firewall NAT rule collections.

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

Required Parameters

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

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network firewall nat-rule collection show

Get the details of an Azure Firewall NAT rule collection.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--collection-name -c

Name of the rule collection.

Property Value
Parameter group: Resource Id Arguments
--firewall-name -f

Azure Firewall name.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False