Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The informationProtectionPolicies resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Security/informationProtectionPolicies resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Security/informationProtectionPolicies@2017-08-01-preview' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
informationTypes: {
{customized property}: {
custom: bool
description: 'string'
displayName: 'string'
enabled: bool
keywords: [
{
canBeNumeric: bool
custom: bool
excluded: bool
pattern: 'string'
}
]
order: int
recommendedLabelId: 'string'
}
}
labels: {
{customized property}: {
description: 'string'
displayName: 'string'
enabled: bool
order: int
rank: 'string'
}
}
}
}
Property Values
Microsoft.Security/informationProtectionPolicies
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'custom' 'effective' (required) |
| properties | Information protection policy data | InformationProtectionPolicyProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
InformationProtectionKeyword
| Name | Description | Value |
|---|---|---|
| canBeNumeric | Indicates whether the keyword can be applied on numeric types or not. | bool |
| custom | Indicates whether the keyword is custom or not. | bool |
| excluded | Indicates whether the keyword is excluded or not. | bool |
| pattern | The keyword pattern. | string |
InformationProtectionPolicyProperties
| Name | Description | Value |
|---|---|---|
| informationTypes | The sensitivity information types. | InformationProtectionPolicyPropertiesInformationTypes |
| labels | Dictionary of sensitivity labels. | InformationProtectionPolicyPropertiesLabels |
InformationProtectionPolicyPropertiesInformationTypes
| Name | Description | Value |
|---|
InformationProtectionPolicyPropertiesLabels
| Name | Description | Value |
|---|
InformationType
| Name | Description | Value |
|---|---|---|
| custom | Indicates whether the information type is custom or not. | bool |
| description | The description of the information type. | string |
| displayName | The name of the information type. | string |
| enabled | Indicates whether the information type is enabled or not. | bool |
| keywords | The information type keywords. | InformationProtectionKeyword[] |
| order | The order of the information type. | int |
| recommendedLabelId | The recommended label id to be associated with this information type. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
SensitivityLabel
| Name | Description | Value |
|---|---|---|
| description | The description of the sensitivity label. | string |
| displayName | The name of the sensitivity label. | string |
| enabled | Indicates whether the label is enabled or not. | bool |
| order | The order of the sensitivity label. | int |
| rank | The rank of the sensitivity label. | 'Critical' 'High' 'Low' 'Medium' 'None' |
ARM template resource definition
The informationProtectionPolicies resource type can be deployed with operations that target:
- Tenant - See tenant deployment commands* Management groups - See management group deployment commands* Subscription - See subscription deployment commands* Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.Security/informationProtectionPolicies resource, add the following JSON to your template.
{
"type": "Microsoft.Security/informationProtectionPolicies",
"apiVersion": "2017-08-01-preview",
"name": "string",
"properties": {
"informationTypes": {
"{customized property}": {
"custom": "bool",
"description": "string",
"displayName": "string",
"enabled": "bool",
"keywords": [
{
"canBeNumeric": "bool",
"custom": "bool",
"excluded": "bool",
"pattern": "string"
}
],
"order": "int",
"recommendedLabelId": "string"
}
},
"labels": {
"{customized property}": {
"description": "string",
"displayName": "string",
"enabled": "bool",
"order": "int",
"rank": "string"
}
}
}
}
Property Values
Microsoft.Security/informationProtectionPolicies
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2017-08-01-preview' |
| name | The resource name | 'custom' 'effective' (required) |
| properties | Information protection policy data | InformationProtectionPolicyProperties |
| type | The resource type | 'Microsoft.Security/informationProtectionPolicies' |
InformationProtectionKeyword
| Name | Description | Value |
|---|---|---|
| canBeNumeric | Indicates whether the keyword can be applied on numeric types or not. | bool |
| custom | Indicates whether the keyword is custom or not. | bool |
| excluded | Indicates whether the keyword is excluded or not. | bool |
| pattern | The keyword pattern. | string |
InformationProtectionPolicyProperties
| Name | Description | Value |
|---|---|---|
| informationTypes | The sensitivity information types. | InformationProtectionPolicyPropertiesInformationTypes |
| labels | Dictionary of sensitivity labels. | InformationProtectionPolicyPropertiesLabels |
InformationProtectionPolicyPropertiesInformationTypes
| Name | Description | Value |
|---|
InformationProtectionPolicyPropertiesLabels
| Name | Description | Value |
|---|
InformationType
| Name | Description | Value |
|---|---|---|
| custom | Indicates whether the information type is custom or not. | bool |
| description | The description of the information type. | string |
| displayName | The name of the information type. | string |
| enabled | Indicates whether the information type is enabled or not. | bool |
| keywords | The information type keywords. | InformationProtectionKeyword[] |
| order | The order of the information type. | int |
| recommendedLabelId | The recommended label id to be associated with this information type. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
SensitivityLabel
| Name | Description | Value |
|---|---|---|
| description | The description of the sensitivity label. | string |
| displayName | The name of the sensitivity label. | string |
| enabled | Indicates whether the label is enabled or not. | bool |
| order | The order of the sensitivity label. | int |
| rank | The rank of the sensitivity label. | 'Critical' 'High' 'Low' 'Medium' 'None' |
Terraform (AzAPI provider) resource definition
The informationProtectionPolicies resource type can be deployed with operations that target:
- Tenant* Management groups* Subscription* Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Security/informationProtectionPolicies resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Security/informationProtectionPolicies@2017-08-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
informationTypes = {
{customized property} = {
custom = bool
description = "string"
displayName = "string"
enabled = bool
keywords = [
{
canBeNumeric = bool
custom = bool
excluded = bool
pattern = "string"
}
]
order = int
recommendedLabelId = "string"
}
}
labels = {
{customized property} = {
description = "string"
displayName = "string"
enabled = bool
order = int
rank = "string"
}
}
}
}
}
Property Values
Microsoft.Security/informationProtectionPolicies
| Name | Description | Value |
|---|---|---|
| name | The resource name | 'custom' 'effective' (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Information protection policy data | InformationProtectionPolicyProperties |
| type | The resource type | "Microsoft.Security/informationProtectionPolicies@2017-08-01-preview" |
InformationProtectionKeyword
| Name | Description | Value |
|---|---|---|
| canBeNumeric | Indicates whether the keyword can be applied on numeric types or not. | bool |
| custom | Indicates whether the keyword is custom or not. | bool |
| excluded | Indicates whether the keyword is excluded or not. | bool |
| pattern | The keyword pattern. | string |
InformationProtectionPolicyProperties
| Name | Description | Value |
|---|---|---|
| informationTypes | The sensitivity information types. | InformationProtectionPolicyPropertiesInformationTypes |
| labels | Dictionary of sensitivity labels. | InformationProtectionPolicyPropertiesLabels |
InformationProtectionPolicyPropertiesInformationTypes
| Name | Description | Value |
|---|
InformationProtectionPolicyPropertiesLabels
| Name | Description | Value |
|---|
InformationType
| Name | Description | Value |
|---|---|---|
| custom | Indicates whether the information type is custom or not. | bool |
| description | The description of the information type. | string |
| displayName | The name of the information type. | string |
| enabled | Indicates whether the information type is enabled or not. | bool |
| keywords | The information type keywords. | InformationProtectionKeyword[] |
| order | The order of the information type. | int |
| recommendedLabelId | The recommended label id to be associated with this information type. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
SensitivityLabel
| Name | Description | Value |
|---|---|---|
| description | The description of the sensitivity label. | string |
| displayName | The name of the sensitivity label. | string |
| enabled | Indicates whether the label is enabled or not. | bool |
| order | The order of the sensitivity label. | int |
| rank | The rank of the sensitivity label. | 'Critical' 'High' 'Low' 'Medium' 'None' |