information_protection_policies

Creates, updates, deletes, gets or lists an information_protection_policies resource.

Overview

Name	information_protection_policies
Type	Resource
Id	azure.security.information_protection_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.
informationTypes	object	The sensitivity information types.
labels	object	Dictionary of sensitivity labels.
lastModifiedUtc	string (date-time)	Describes the last UTC time the policy was modified.
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".
version	string	Describes the version of the policy.

list

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.
informationTypes	object	The sensitivity information types.
labels	object	Dictionary of sensitivity labels.
lastModifiedUtc	string (date-time)	Describes the last UTC time the policy was modified.
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".
version	string	Describes the version of the policy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	scope, information_protection_policy_name		Details of the information protection policy.
list	select	scope		Information protection policies of a specific management group.
create_or_update	insert	scope, information_protection_policy_name		Details of the information protection policy.
create_or_update	replace	scope, information_protection_policy_name		Details of the information protection 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
information_protection_policy_name	string	Name of the information protection policy. Known values are: "effective" and "custom". Required.
scope	string	The fully qualified Azure Resource manager identifier of the resource. Required.

SELECT examples

get

Details of the information protection policy.

SELECT
id,
name,
informationTypes,
labels,
lastModifiedUtc,
systemData,
type,
version
FROM azure.security.information_protection_policies
WHERE scope = '{{ scope }}' -- required
AND information_protection_policy_name = '{{ information_protection_policy_name }}' -- required
;

list

Information protection policies of a specific management group.

SELECT
id,
name,
informationTypes,
labels,
lastModifiedUtc,
systemData,
type,
version
FROM azure.security.information_protection_policies
WHERE scope = '{{ scope }}' -- required
;

INSERT examples

create_or_update

Details of the information protection policy.

INSERT INTO azure.security.information_protection_policies (
properties,
scope,
information_protection_policy_name
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ information_protection_policy_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: information_protection_policies
props:
  - name: scope
    value: "{{ scope }}"
    description: Required parameter for the information_protection_policies resource.
  - name: information_protection_policy_name
    value: "{{ information_protection_policy_name }}"
    description: Required parameter for the information_protection_policies resource.
  - name: properties
    description: |
      Information protection policy data.
    value:
      lastModifiedUtc: "{{ lastModifiedUtc }}"
      version: "{{ version }}"
      labels: "{{ labels }}"
      informationTypes: "{{ informationTypes }}"

REPLACE examples

create_or_update

Details of the information protection policy.

REPLACE azure.security.information_protection_policies
SET 
properties = '{{ properties }}'
WHERE 
scope = '{{ scope }}' --required
AND information_protection_policy_name = '{{ information_protection_policy_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;