firewall_policy_rule_collection_groups

Creates, updates, deletes, gets or lists a firewall_policy_rule_collection_groups resource.

Overview

Name	firewall_policy_rule_collection_groups
Type	Resource
Id	azure.network.firewall_policy_rule_collection_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
priority	integer	Priority of the Firewall Policy Rule Collection Group resource.
provisioningState	string	The provisioning state of the firewall policy rule collection group resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
ruleCollections	array	Group of Firewall Policy rule collections.
size	string	A read-only string that represents the size of the FirewallPolicyRuleCollectionGroupProperties in MB. (ex 1.2MB).
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
priority	integer	Priority of the Firewall Policy Rule Collection Group resource.
provisioningState	string	The provisioning state of the firewall policy rule collection group resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
ruleCollections	array	Group of Firewall Policy rule collections.
size	string	A read-only string that represents the size of the FirewallPolicyRuleCollectionGroupProperties in MB. (ex 1.2MB).
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, firewall_policy_name, rule_collection_group_name, subscription_id		Gets the specified FirewallPolicyRuleCollectionGroup.
list	select	resource_group_name, firewall_policy_name, subscription_id		Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.
create_or_update	insert	resource_group_name, firewall_policy_name, rule_collection_group_name, subscription_id		Creates or updates the specified FirewallPolicyRuleCollectionGroup.
create_or_update	replace	resource_group_name, firewall_policy_name, rule_collection_group_name, subscription_id		Creates or updates the specified FirewallPolicyRuleCollectionGroup.
delete	delete	resource_group_name, firewall_policy_name, rule_collection_group_name, subscription_id		Deletes the specified FirewallPolicyRuleCollectionGroup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
firewall_policy_name	string	The name of the Firewall Policy. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_collection_group_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
subscription_id	string

SELECT examples

get

Gets the specified FirewallPolicyRuleCollectionGroup.

SELECT
id,
name,
etag,
priority,
provisioningState,
ruleCollections,
size,
type
FROM azure.network.firewall_policy_rule_collection_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND firewall_policy_name = '{{ firewall_policy_name }}' -- required
AND rule_collection_group_name = '{{ rule_collection_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.

SELECT
id,
name,
etag,
priority,
provisioningState,
ruleCollections,
size,
type
FROM azure.network.firewall_policy_rule_collection_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND firewall_policy_name = '{{ firewall_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified FirewallPolicyRuleCollectionGroup.

INSERT INTO azure.network.firewall_policy_rule_collection_groups (
id,
name,
properties,
resource_group_name,
firewall_policy_name,
rule_collection_group_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ firewall_policy_name }}',
'{{ rule_collection_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: firewall_policy_rule_collection_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the firewall_policy_rule_collection_groups resource.
  - name: firewall_policy_name
    value: "{{ firewall_policy_name }}"
    description: Required parameter for the firewall_policy_rule_collection_groups resource.
  - name: rule_collection_group_name
    value: "{{ rule_collection_group_name }}"
    description: Required parameter for the firewall_policy_rule_collection_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the firewall_policy_rule_collection_groups resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      The properties of the firewall policy rule collection group.
    value:
      size: "{{ size }}"
      priority: {{ priority }}
      ruleCollections:
        - ruleCollectionType: "{{ ruleCollectionType }}"
          name: "{{ name }}"
          priority: {{ priority }}
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates the specified FirewallPolicyRuleCollectionGroup.

REPLACE azure.network.firewall_policy_rule_collection_groups
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND firewall_policy_name = '{{ firewall_policy_name }}' --required
AND rule_collection_group_name = '{{ rule_collection_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified FirewallPolicyRuleCollectionGroup.

DELETE FROM azure.network.firewall_policy_rule_collection_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND firewall_policy_name = '{{ firewall_policy_name }}' --required
AND rule_collection_group_name = '{{ rule_collection_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;