az network firewall policy rule-collection-group

Note

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

Manage and configure Azure firewall policy rule collection group.

Commands

Name	Description	Type	Status
az network firewall policy rule-collection-group collection	Manage and configure Azure firewall policy rule collections in the rule collection group.	Extension	GA
az network firewall policy rule-collection-group collection add-filter-collection	Add a filter collection into an Azure firewall policy rule collection group.	Extension	Preview
az network firewall policy rule-collection-group collection add-nat-collection	Add a NAT collection into an Azure firewall policy rule collection group.	Extension	Preview
az network firewall policy rule-collection-group collection list	List all rule collections of an Azure firewall policy rule collection group.	Extension	Preview
az network firewall policy rule-collection-group collection remove	Remove a rule collection from an Azure firewall policy rule collection group.	Extension	Preview
az network firewall policy rule-collection-group collection rule	Manage and configure the rule of a filter collection in the rule collection group of Azure firewall policy.	Extension	GA
az network firewall policy rule-collection-group collection rule add	Add a rule into an Azure firewall policy rule collection.	Extension	Preview
az network firewall policy rule-collection-group collection rule remove	Remove a rule from an Azure firewall policy rule collection.	Extension	Preview
az network firewall policy rule-collection-group collection rule update	Update a rule of an Azure firewall policy rule collection.	Extension	Preview
az network firewall policy rule-collection-group create	Create an Azure firewall policy rule collection group.	Extension	Preview
az network firewall policy rule-collection-group delete	Delete an Azure Firewall policy rule collection group.	Extension	Preview
az network firewall policy rule-collection-group draft	Manage and configure Azure firewall policy rule-collection-group draft.	Extension	GA
az network firewall policy rule-collection-group draft collection	Manage and configure Azure firewall policy rule collections in the rule collection group draft.	Extension	GA
az network firewall policy rule-collection-group draft collection add-filter-collection	Add a filter collection into an Azure firewall policy rule collection group draft.	Extension	Preview
az network firewall policy rule-collection-group draft collection add-nat-collection	Add a NAT collection into an Azure firewall policy rule collection group draft.	Extension	Preview
az network firewall policy rule-collection-group draft collection list	List all rule collections of an Azure firewall policy rule collection group draft.	Extension	Preview
az network firewall policy rule-collection-group draft collection remove	Remove a rule collection from an Azure firewall policy rule collection group draft.	Extension	Preview
az network firewall policy rule-collection-group draft collection rule	Manage and configure the rule of a filter collection in the rule collection group of Azure firewall policy.	Extension	GA
az network firewall policy rule-collection-group draft collection rule add	Add a rule into an Azure firewall policy draft rule collection.	Extension	Preview
az network firewall policy rule-collection-group draft collection rule remove	Remove a rule from an Azure firewall policy rule collection draft.	Extension	Preview
az network firewall policy rule-collection-group draft collection rule update	Update a rule of an Azure firewall policy rule collection.	Extension	Preview
az network firewall policy rule-collection-group draft create	Create an Azure firewall policy rule collection group draft.	Extension	Preview
az network firewall policy rule-collection-group draft delete	Delete Rule Collection Group Draft.	Extension	Preview
az network firewall policy rule-collection-group draft show	Get Rule Collection Group Draft.	Extension	Preview
az network firewall policy rule-collection-group draft update	Update an Azure firewall policy rule collection group.	Extension	GA
az network firewall policy rule-collection-group list	List all Azure firewall policy rule collection groups.	Extension	Preview
az network firewall policy rule-collection-group show	Show an Azure firewall policy rule collection group.	Extension	Preview
az network firewall policy rule-collection-group update	Update an Azure firewall policy rule collection group.	Extension	Preview
az network firewall policy rule-collection-group wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az network firewall policy rule-collection-group create

Preview

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

Create an Azure firewall policy rule collection group.

az network firewall policy rule-collection-group create --name
                                                        --policy-name
                                                        --priority
                                                        --resource-group
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Required Parameters

--name -n

The name of the Firewall Policy Rule Collection Group.

--policy-name

The name of the Firewall Policy.

--priority

Priority of the Firewall Policy Rule Collection Group.

Property	Value
Parameter group:	Properties Arguments

--resource-group -g

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

Optional Parameters

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

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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 policy rule-collection-group delete

Preview

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

Delete an Azure Firewall policy rule collection group.

az network firewall policy rule-collection-group delete [--ids]
                                                        [--name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--policy-name]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--yes]

Optional Parameters

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

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

--name -n

The name of the Firewall Policy Rule Collection Group.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--policy-name

The name of the Firewall Policy.

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

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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 policy rule-collection-group list

Preview

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

List all Azure firewall policy rule collection groups.

az network firewall policy rule-collection-group list --policy-name
                                                      --resource-group
                                                      [--max-items]
                                                      [--next-token]

Required Parameters

--policy-name

The name of the Firewall Policy.

--resource-group -g

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

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination 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.

--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 policy rule-collection-group show

Preview

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

Show an Azure firewall policy rule collection group.

az network firewall policy rule-collection-group show [--ids]
                                                      [--name]
                                                      [--policy-name]
                                                      [--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.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the Firewall Policy Rule Collection Group.

Property	Value
Parameter group:	Resource Id Arguments

--policy-name

The name of the Firewall Policy.

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 policy rule-collection-group update

Preview

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

Update an Azure firewall policy rule collection group.

az network firewall policy rule-collection-group update [--add]
                                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--ids]
                                                        [--name]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--policy-name]
                                                        [--priority]
                                                        [--remove]
                                                        [--resource-group]
                                                        [--set]
                                                        [--subscription]
                                                        [--tags]

Optional Parameters

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

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

Property	Value
Parameter group:	Generic Update Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name -n

The name of the Firewall Policy Rule Collection Group.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--policy-name

The name of the Firewall Policy.

Property	Value
Parameter group:	Resource Id Arguments

--priority

Priority of the Firewall Policy Rule Collection Group.

Property	Value
Parameter group:	Properties Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update 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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 policy rule-collection-group wait

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

az network firewall policy rule-collection-group wait [--created]
                                                      [--custom]
                                                      [--deleted]
                                                      [--exists]
                                                      [--ids]
                                                      [--interval]
                                                      [--name]
                                                      [--policy-name]
                                                      [--resource-group]
                                                      [--subscription]
                                                      [--timeout]
                                                      [--updated]

Optional Parameters

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

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name -n

The name of the Firewall Policy Rule Collection Group.

Property	Value
Parameter group:	Resource Id Arguments

--policy-name

The name of the Firewall Policy.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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

Share via

az network firewall policy rule-collection-group

Commands

az network firewall policy rule-collection-group create

Required Parameters

Optional Parameters

az network firewall policy rule-collection-group delete

Optional Parameters

az network firewall policy rule-collection-group list

Required Parameters

Optional Parameters

az network firewall policy rule-collection-group show

Optional Parameters

az network firewall policy rule-collection-group update

Optional Parameters

az network firewall policy rule-collection-group wait

Optional Parameters

Feedback