web_application_firewall_policies

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

Overview

Name	web_application_firewall_policies
Type	Resource
Id	azure.network.web_application_firewall_policies

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the web application firewall policy.
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

OK. The request has succeeded.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the web application firewall policy.
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_all

OK. The request has succeeded.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the web application firewall policy.
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	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_all	select	subscriptionId		Gets all the WAF policies in a subscription.
create_or_update	insert	resourceGroupName, policyName, subscriptionId		Creates or update policy with specified rule set name within a 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 policy.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Retrieve protection policy with specified name within a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.web_application_firewall_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,
properties,
systemData,
type
FROM azure.network.web_application_firewall_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_all

Gets all the WAF policies in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.web_application_firewall_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.network.web_application_firewall_policies (
data__properties,
resourceGroupName,
policyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ policyName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: web_application_firewall_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the web_application_firewall_policies resource.
    - name: policyName
      value: string
      description: Required parameter for the web_application_firewall_policies resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the web_application_firewall_policies resource.
    - name: properties
      value: object
      description: |
        Properties of the web application firewall policy.

DELETE examples

delete

Deletes Policy.

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