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
properties	object	The JSON object that contains the properties of the Rules to create.

list_by_rule_set

Name	Datatype	Description
properties	object	The JSON object that contains the properties of the Rules to create.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, profileName, ruleSetName, ruleName, subscriptionId		Gets an existing delivery rule within a rule set.
list_by_rule_set	select	resourceGroupName, profileName, ruleSetName, subscriptionId		Lists all of the existing delivery rules within a rule set.
create	insert	resourceGroupName, profileName, ruleSetName, ruleName, subscriptionId		Creates a new delivery rule within the specified rule set.
update	update	resourceGroupName, profileName, ruleSetName, ruleName, subscriptionId		Updates an existing delivery rule within a rule set.
delete	delete	resourceGroupName, profileName, ruleSetName, ruleName, subscriptionId		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
profileName	string	Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
resourceGroupName	string	Name of the Resource group within the Azure subscription.
ruleName	string	Name of the delivery rule which is unique within the endpoint.
ruleSetName	string	Name of the rule set under the profile.
subscriptionId	string	Azure Subscription ID.

SELECT examples

get

Gets an existing delivery rule within a rule set.

SELECT
properties
FROM azure.cdn.rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND ruleSetName = '{{ ruleSetName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_rule_set

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

SELECT
properties
FROM azure.cdn.rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND ruleSetName = '{{ ruleSetName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new delivery rule within the specified rule set.

INSERT INTO azure.cdn.rules (
data__properties,
resourceGroupName,
profileName,
ruleSetName,
ruleName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ ruleSetName }}',
'{{ ruleName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the rules resource.
    - name: profileName
      value: string
      description: Required parameter for the rules resource.
    - name: ruleSetName
      value: string
      description: Required parameter for the rules resource.
    - name: ruleName
      value: string
      description: Required parameter for the rules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the rules resource.
    - name: properties
      value: object
      description: |
        The JSON object that contains the properties of the Rules to create.

UPDATE examples

update

Updates an existing delivery rule within a rule set.

UPDATE azure.cdn.rules
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND ruleSetName = '{{ ruleSetName }}' --required
AND ruleName = '{{ ruleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes an existing delivery rule within a rule set.

DELETE FROM azure.cdn.rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND ruleSetName = '{{ ruleSetName }}' --required
AND ruleName = '{{ ruleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;