security_policies

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

Overview

Name	security_policies
Type	Resource
Id	azure.cdn.security_policies

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.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
parameters	object	object which contains security policy parameters.
profileName	string	The name of the profile which holds the security policy.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
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_by_profile

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.
deploymentStatus	string	Known values are: "NotStarted", "InProgress", "Succeeded", and "Failed". (NotStarted, InProgress, Succeeded, Failed)
parameters	object	object which contains security policy parameters.
profileName	string	The name of the profile which holds the security policy.
provisioningState	string	Provisioning status. Known values are: "Succeeded", "Failed", "Updating", "Deleting", and "Creating". (Succeeded, Failed, Updating, Deleting, Creating)
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	resource_group_name, profile_name, security_policy_name, subscription_id		Gets an existing security policy within a profile.
list_by_profile	select	resource_group_name, profile_name, subscription_id		Lists security policies associated with the profile.
create	insert	resource_group_name, profile_name, security_policy_name, subscription_id		Creates a new security policy within the specified profile.
delete	delete	resource_group_name, profile_name, security_policy_name, subscription_id		Deletes an existing security policy within profile.
patch	exec	resource_group_name, profile_name, security_policy_name, subscription_id		Updates an existing security policy within a 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
profile_name	string	Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
security_policy_name	string	Name of the security policy under the profile. Required.
subscription_id	string

SELECT examples

get

Gets an existing security policy within a profile.

SELECT
id,
name,
deploymentStatus,
parameters,
profileName,
provisioningState,
systemData,
type
FROM azure.cdn.security_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND security_policy_name = '{{ security_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_profile

Lists security policies associated with the profile.

SELECT
id,
name,
deploymentStatus,
parameters,
profileName,
provisioningState,
systemData,
type
FROM azure.cdn.security_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND profile_name = '{{ profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new security policy within the specified profile.

INSERT INTO azure.cdn.security_policies (
properties,
resource_group_name,
profile_name,
security_policy_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ profile_name }}',
'{{ security_policy_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the security_policies resource.
  - name: profile_name
    value: "{{ profile_name }}"
    description: Required parameter for the security_policies resource.
  - name: security_policy_name
    value: "{{ security_policy_name }}"
    description: Required parameter for the security_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the security_policies resource.
  - name: properties
    description: |
      The json object that contains properties required to create a security policy.
    value:
      provisioningState: "{{ provisioningState }}"
      deploymentStatus: "{{ deploymentStatus }}"
      profileName: "{{ profileName }}"
      parameters:
        type: "{{ type }}"

DELETE examples

delete

Deletes an existing security policy within profile.

DELETE FROM azure.cdn.security_policies
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND profile_name = '{{ profile_name }}' --required
AND security_policy_name = '{{ security_policy_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

patch

Updates an existing security policy within a profile.

EXEC azure.cdn.security_policies.patch 
@resource_group_name='{{ resource_group_name }}' --required, 
@profile_name='{{ profile_name }}' --required, 
@security_policy_name='{{ security_policy_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;