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 (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
properties	object	Information protection policy data
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 (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
properties	object	Information protection policy data
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	scope, informationProtectionPolicyName	api-version	Details of the information protection policy.
list	select	scope	api-version	Information protection policies of a specific management group.
create_or_update	insert	scope, informationProtectionPolicyName	api-version	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
informationProtectionPolicyName	string	Name of the information protection policy.
scope	string	The scope of the standard assignment. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
api-version	string	API version for the operation

SELECT examples

get

Details of the information protection policy.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.information_protection_policies
WHERE scope = '{{ scope }}' -- required
AND informationProtectionPolicyName = '{{ informationProtectionPolicyName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Information protection policies of a specific management group.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.information_protection_policies
WHERE scope = '{{ scope }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create_or_update

Details of the information protection policy.

INSERT INTO azure.security.information_protection_policies (
data__properties,
scope,
informationProtectionPolicyName,
api-version
)
SELECT 
'{{ properties }}',
'{{ scope }}',
'{{ informationProtectionPolicyName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: information_protection_policies
  props:
    - name: scope
      value: string
      description: Required parameter for the information_protection_policies resource.
    - name: informationProtectionPolicyName
      value: string
      description: Required parameter for the information_protection_policies resource.
    - name: properties
      value: object
      description: |
        Information protection policy data
    - name: api-version
      value: string
      description: API version for the operation