policies

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

Overview

Name	policies
Type	Resource
Id	azure.front_door.policies

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	Gets a unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the web application firewall policy.
sku	object	The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified.
tags	object	Resource tags.
type	string	Resource type.

list

OK. The request has succeeded.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	Gets a unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the web application firewall policy.
sku	object	The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified.
tags	object	Resource tags.
type	string	Resource type.

list_by_subscription

OK. The request has succeeded.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	Gets a unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the web application firewall policy.
sku	object	The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, policyName, subscriptionId		Retrieve protection policy with specified name within a resource group.
list	select	resourceGroupName, subscriptionId		Lists all of the protection policies within a resource group.
list_by_subscription	select	subscriptionId		Lists all of the protection policies within a subscription.
create_or_update	insert	resourceGroupName, policyName, subscriptionId		Create or update policy with specified rule set name within a resource group.
update	update	resourceGroupName, policyName, subscriptionId		Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.
delete	delete	resourceGroupName, policyName, subscriptionId		Deletes Policy

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
policyName	string	The name of the Web Application Firewall Policy.
resourceGroupName	string	Name of the Resource group within the Azure subscription.
subscriptionId	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Retrieve protection policy with specified name within a resource group.

SELECT
id,
name,
etag,
location,
properties,
sku,
tags,
type
FROM azure.front_door.policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND policyName = '{{ policyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all of the protection policies within a resource group.

SELECT
id,
name,
etag,
location,
properties,
sku,
tags,
type
FROM azure.front_door.policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists all of the protection policies within a subscription.

SELECT
id,
name,
etag,
location,
properties,
sku,
tags,
type
FROM azure.front_door.policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create or update policy with specified rule set name within a resource group.

INSERT INTO azure.front_door.policies (
data__properties,
data__etag,
data__sku,
data__location,
data__tags,
resourceGroupName,
policyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ sku }}',
'{{ location }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ policyName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the policies resource.
    - name: policyName
      value: string
      description: Required parameter for the policies resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the policies resource.
    - name: properties
      value: object
      description: |
        Properties of the web application firewall policy.
    - name: etag
      value: string
      description: |
        Gets a unique read-only string that changes whenever the resource is updated.
    - name: sku
      value: object
      description: |
        The pricing tier of web application firewall policy. Defaults to Classic_AzureFrontDoor if not specified.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.

UPDATE examples

update

Patch a specific frontdoor webApplicationFirewall policy for tags update under the specified subscription and resource group.

UPDATE azure.front_door.policies
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND policyName = '{{ policyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Deletes Policy

DELETE FROM azure.front_door.policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND policyName = '{{ policyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;