waf_policy

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

Overview

Name	waf_policy
Type	Resource
Id	azure_isv.nginx.waf_policy

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.
applyingState	object	Nginx Deployment Waf Policy Applying Status.
compilingState	object	Nginx Deployment Waf Policy Compiling Status.
content	string (byte)	The byte content of the Policy.
filepath	string	The file path where the Policy is to be saved.
provisioningState	string	Provisioning State. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
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

Name	Datatype	Description
id	string	:vartype id: str
name	string	:vartype name: str
applyingState	object	Nginx Deployment Waf Policy Applying Status.
compilingState	object	Nginx Deployment Waf Policy Compiling Status.
filepath	string	:vartype filepath: str
provisioningState	string	Provisioning State. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	:vartype type: str

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, deployment_name, waf_policy_name, subscription_id		Get the Nginx Waf Policy of given Nginx deployment.
list	select	resource_group_name, deployment_name, subscription_id		List Waf Policies of given Nginx deployment.
create	insert	resource_group_name, deployment_name, waf_policy_name, subscription_id		Create or update the Nginx Waf Policy for given Nginx deployment.
delete	delete	resource_group_name, deployment_name, waf_policy_name, subscription_id		Reset the Nginx Waf Policy of given Nginx deployment to default.

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
deployment_name	string	The name of targeted NGINX deployment. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
waf_policy_name	string	The name of Waf Policy. Required.

SELECT examples

get

Get the Nginx Waf Policy of given Nginx deployment.

SELECT
id,
name,
applyingState,
compilingState,
content,
filepath,
provisioningState,
systemData,
type
FROM azure_isv.nginx.waf_policy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND waf_policy_name = '{{ waf_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List Waf Policies of given Nginx deployment.

SELECT
id,
name,
applyingState,
compilingState,
filepath,
provisioningState,
systemData,
type
FROM azure_isv.nginx.waf_policy
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create or update the Nginx Waf Policy for given Nginx deployment.

INSERT INTO azure_isv.nginx.waf_policy (
properties,
resource_group_name,
deployment_name,
waf_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ deployment_name }}',
'{{ waf_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: waf_policy
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the waf_policy resource.
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the waf_policy resource.
  - name: waf_policy_name
    value: "{{ waf_policy_name }}"
    description: Required parameter for the waf_policy resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the waf_policy resource.
  - name: properties
    description: |
      Nginx Deployment Waf Policy Properties.
    value:
      provisioningState: "{{ provisioningState }}"
      content: "{{ content }}"
      filepath: "{{ filepath }}"
      compilingState:
        code: "{{ code }}"
        displayStatus: "{{ displayStatus }}"
        time: "{{ time }}"
      applyingState:
        code: "{{ code }}"
        displayStatus: "{{ displayStatus }}"
        time: "{{ time }}"

DELETE examples

delete

Reset the Nginx Waf Policy of given Nginx deployment to default.

DELETE FROM azure_isv.nginx.waf_policy
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND deployment_name = '{{ deployment_name }}' --required
AND waf_policy_name = '{{ waf_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;