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

Request successful. The operation returns a FirewallPolicyRuleCollectionGroup resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The properties of the firewall policy rule collection group.
type	string	Rule Group type.

list

Success. The operation returns a list of FirewallPolicyRuleCollectionGroup resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	The properties of the firewall policy rule collection group.
type	string	Rule Group type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, firewallPolicyName, ruleCollectionGroupName, subscriptionId		Gets the specified FirewallPolicyRuleCollectionGroup.
list	select	resourceGroupName, firewallPolicyName, subscriptionId		Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.
create_or_update	insert	resourceGroupName, firewallPolicyName, ruleCollectionGroupName, subscriptionId		Creates or updates the specified FirewallPolicyRuleCollectionGroup.
delete	delete	resourceGroupName, firewallPolicyName, ruleCollectionGroupName, subscriptionId		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
firewallPolicyName	string	The name of the Firewall Policy.
resourceGroupName	string	The name of the resource group.
ruleCollectionGroupName	string	The name of the FirewallPolicyRuleCollectionGroup.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified FirewallPolicyRuleCollectionGroup.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.firewall_policy_rule_collection_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND firewallPolicyName = '{{ firewallPolicyName }}' -- required
AND ruleCollectionGroupName = '{{ ruleCollectionGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.firewall_policy_rule_collection_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND firewallPolicyName = '{{ firewallPolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified FirewallPolicyRuleCollectionGroup.

INSERT INTO azure.network.firewall_policy_rule_collection_groups (
data__properties,
data__name,
data__id,
resourceGroupName,
firewallPolicyName,
ruleCollectionGroupName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ firewallPolicyName }}',
'{{ ruleCollectionGroupName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: firewall_policy_rule_collection_groups
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the firewall_policy_rule_collection_groups resource.
    - name: firewallPolicyName
      value: string
      description: Required parameter for the firewall_policy_rule_collection_groups resource.
    - name: ruleCollectionGroupName
      value: string
      description: Required parameter for the firewall_policy_rule_collection_groups resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the firewall_policy_rule_collection_groups resource.
    - name: properties
      value: object
      description: |
        The properties of the firewall policy rule collection group.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified FirewallPolicyRuleCollectionGroup.

DELETE FROM azure.network.firewall_policy_rule_collection_groups
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND firewallPolicyName = '{{ firewallPolicyName }}' --required
AND ruleCollectionGroupName = '{{ ruleCollectionGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;