rules

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

Overview

Name	rules
Type	Resource
Id	azure.cdn.rules

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.
actions	array	A list of actions that are executed when all the conditions of a rule are satisfied.
conditions	array	A list of conditions that must be matched for the actions to be executed.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
matchProcessingBehavior	string	If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: "Continue" and "Stop". (Continue, Stop)
order	integer	The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
ruleSetName	string	The name of the rule set containing the rule.
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_rule_set

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.
actions	array	A list of actions that are executed when all the conditions of a rule are satisfied.
conditions	array	A list of conditions that must be matched for the actions to be executed.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
matchProcessingBehavior	string	If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. Known values are: "Continue" and "Stop". (Continue, Stop)
order	integer	The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
ruleSetName	string	The name of the rule set containing the rule.
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, rule_name, subscription_id		Gets an existing delivery rule within a rule set.
list_by_rule_set	select	resource_group_name, profile_name, rule_set_name, subscription_id		Lists all of the existing delivery rules within a rule set.
create	insert	resource_group_name, profile_name, rule_set_name, rule_name, subscription_id		Creates a new delivery rule within the specified rule set.
update	update	resource_group_name, profile_name, rule_set_name, rule_name, subscription_id		Updates an existing delivery rule within a rule set.
delete	delete	resource_group_name, profile_name, rule_set_name, rule_name, subscription_id		Deletes an existing delivery rule within a rule set.

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_name	string	Name of the delivery rule which is unique within the endpoint. 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 delivery rule within a rule set.

SELECT
id,
name,
actions,
conditions,
deploymentStatus,
matchProcessingBehavior,
order,
provisioningState,
ruleSetName,
systemData,
type
FROM azure.cdn.rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND rule_set_name = '{{ rule_set_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_rule_set

Lists all of the existing delivery rules within a rule set.

SELECT
id,
name,
actions,
conditions,
deploymentStatus,
matchProcessingBehavior,
order,
provisioningState,
ruleSetName,
systemData,
type
FROM azure.cdn.rules
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
;

INSERT examples

create

Creates a new delivery rule within the specified rule set.

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

Manifest

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

UPDATE examples

update

Updates an existing delivery rule within a rule set.

UPDATE azure.cdn.rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND rule_set_name = '{{ rule_set_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an existing delivery rule within a rule set.

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