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
- list_by_profile
Name | Datatype | Description |
---|---|---|
properties | object | The JSON object that contains the properties of the Rule Set to create. |
Name | Datatype | Description |
---|---|---|
properties | object | The JSON object that contains the properties of the Rule Set to create. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | resourceGroupName , profileName , ruleSetName , subscriptionId | Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile. | |
list_by_profile | select | resourceGroupName , profileName , subscriptionId | Lists existing AzureFrontDoor rule sets within a profile. | |
create | insert | resourceGroupName , profileName , ruleSetName , subscriptionId | Creates a new rule set within the specified profile. | |
delete | delete | resourceGroupName , profileName , ruleSetName , subscriptionId | Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and 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 |
---|---|---|
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. |
ruleSetName | string | Name of the rule set under the profile which is unique globally. |
subscriptionId | string | Azure Subscription ID. |
SELECT
examples
- get
- list_by_profile
Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
SELECT
properties
FROM azure.cdn.rule_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND ruleSetName = '{{ ruleSetName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
Lists existing AzureFrontDoor rule sets within a profile.
SELECT
properties
FROM azure.cdn.rule_sets
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND profileName = '{{ profileName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;
INSERT
examples
- create
- Manifest
Creates a new rule set within the specified profile.
INSERT INTO azure.cdn.rule_sets (
resourceGroupName,
profileName,
ruleSetName,
subscriptionId
)
SELECT
'{{ resourceGroupName }}',
'{{ profileName }}',
'{{ ruleSetName }}',
'{{ subscriptionId }}'
RETURNING
properties
;
# Description fields are for documentation purposes
- name: rule_sets
props:
- name: resourceGroupName
value: string
description: Required parameter for the rule_sets resource.
- name: profileName
value: string
description: Required parameter for the rule_sets resource.
- name: ruleSetName
value: string
description: Required parameter for the rule_sets resource.
- name: subscriptionId
value: string
description: Required parameter for the rule_sets resource.
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 resourceGroupName = '{{ resourceGroupName }}' --required
AND profileName = '{{ profileName }}' --required
AND ruleSetName = '{{ ruleSetName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;