rule_sets

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

Overview

Name	rule_sets
Type	Resource
Id	azure.cdn.rule_sets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
batchMode	boolean	Indicates whether rule set is in batch mode. When batch mode is enabled, rules will be processed in a batch along with the rule set. When batch mode is disabled, rules would need to be processed independently. This property can only be set during rule set creation and cannot be updated later. For switching modes, a new rule set needs to be created with the desired mode and rules need to be migrated to the new rule set.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
profileName	string	The name of the profile which holds the rule set.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
rules	array	A list of rules that are part of this rule set provided the rule set is in batch mode. This property will be ignored if the rule set is not in batch mode.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_profile

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
batchMode	boolean	Indicates whether rule set is in batch mode. When batch mode is enabled, rules will be processed in a batch along with the rule set. When batch mode is disabled, rules would need to be processed independently. This property can only be set during rule set creation and cannot be updated later. For switching modes, a new rule set needs to be created with the desired mode and rules need to be migrated to the new rule set.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
profileName	string	The name of the profile which holds the rule set.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
rules	array	A list of rules that are part of this rule set provided the rule set is in batch mode. This property will be ignored if the rule set is not in batch mode.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, profile_name, rule_set_name, subscription_id		Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
list_by_profile	select	resource_group_name, profile_name, subscription_id		Lists existing AzureFrontDoor rule sets within a profile.
create	insert	resource_group_name, profile_name, rule_set_name, subscription_id		Creates or update a batch rule set within the specified profile along with the rules associate to it.
delete	delete	resource_group_name, profile_name, rule_set_name, subscription_id		Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
list_resource_usage	exec	resource_group_name, profile_name, rule_set_name, subscription_id		Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

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
profile_name	string	Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_set_name	string	Name of the rule set under the profile which is unique globally. Required.
subscription_id	string

SELECT examples

get

Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.

SELECT
id,
name,
batchMode,
deploymentStatus,
profileName,
provisioningState,
rules,
systemData,
type
FROM azure.cdn.rule_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND rule_set_name = '{{ rule_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_profile

Lists existing AzureFrontDoor rule sets within a profile.

SELECT
id,
name,
batchMode,
deploymentStatus,
profileName,
provisioningState,
rules,
systemData,
type
FROM azure.cdn.rule_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or update a batch rule set within the specified profile along with the rules associate to it.

INSERT INTO azure.cdn.rule_sets (
properties,
resource_group_name,
profile_name,
rule_set_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ rule_set_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: rule_sets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the rule_sets resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the rule_sets resource.
  - name: rule_set_name
    value: "{{ rule_set_name }}"
    description: Required parameter for the rule_sets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the rule_sets resource.
  - name: properties
    description: |
      The JSON object that contains the properties of the Rule Set to create.
    value:
      provisioningState: "{{ provisioningState }}"
      deploymentStatus: "{{ deploymentStatus }}"
      profileName: "{{ profileName }}"
      batchMode: {{ batchMode }}
      rules:
        - ruleName: "{{ ruleName }}"
          ruleSetName: "{{ ruleSetName }}"
          order: {{ order }}
          conditions: "{{ conditions }}"
          actions: "{{ actions }}"
          matchProcessingBehavior: "{{ matchProcessingBehavior }}"

DELETE examples

delete

Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.

DELETE FROM azure.cdn.rule_sets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND rule_set_name = '{{ rule_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_resource_usage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile.

EXEC azure.cdn.rule_sets.list_resource_usage 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@rule_set_name='{{ rule_set_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;