Microsoft.Security informationProtectionPolicies 2017-08-01-preview
Bicep resource definition
The informationProtectionPolicies resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.
The informationProtectionPolicies resource type can be deployed with operations that target:
- 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' = {
name: 'string'
scope: resourceSymbolicName
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
informationProtectionPolicies
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: see values Valid characters: Use one of: customeffective |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource. |
| properties | Information protection policy data | InformationProtectionPolicyProperties |
InformationProtectionPolicyProperties
| Name | Description | Value |
|---|---|---|
| informationTypes | The sensitivity information types. | InformationProtectionPolicyPropertiesInformationType... |
| labels | Dictionary of sensitivity labels. | InformationProtectionPolicyPropertiesLabels |
InformationProtectionPolicyPropertiesInformationType...
| Name | Description | Value |
|---|---|---|
| {customized property} | InformationType |
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}$ |
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 |
InformationProtectionPolicyPropertiesLabels
| Name | Description | Value |
|---|---|---|
| {customized property} | SensitivityLabel |
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 is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.
The informationProtectionPolicies resource type can be deployed with operations that target:
- 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 JSON to your template.
{
"type": "Microsoft.Security/informationProtectionPolicies",
"apiVersion": "2017-08-01-preview",
"name": "string",
"scope": "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
informationProtectionPolicies
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Security/informationProtectionPolicies' |
| apiVersion | The resource api version | '2017-08-01-preview' |
| name | The resource name | string (required) Character limit: see values Valid characters: Use one of: customeffective |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For JSON, set the value to the full name of the resource to apply the extension resource to. |
| properties | Information protection policy data | InformationProtectionPolicyProperties |
InformationProtectionPolicyProperties
| Name | Description | Value |
|---|---|---|
| informationTypes | The sensitivity information types. | InformationProtectionPolicyPropertiesInformationType... |
| labels | Dictionary of sensitivity labels. | InformationProtectionPolicyPropertiesLabels |
InformationProtectionPolicyPropertiesInformationType...
| Name | Description | Value |
|---|---|---|
| {customized property} | InformationType |
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}$ |
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 |
InformationProtectionPolicyPropertiesLabels
| Name | Description | Value |
|---|---|---|
| {customized property} | SensitivityLabel |
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 is an extension resource, which means you can apply it to another resource.
Use the parent_id property on this resource to set the scope for this resource.
The informationProtectionPolicies resource type can be deployed with operations that target:
- 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 = jsonencode({
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
informationProtectionPolicies
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Security/informationProtectionPolicies@2017-08-01-preview" |
| name | The resource name | string (required) Character limit: see values Valid characters: Use one of: customeffective |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| properties | Information protection policy data | InformationProtectionPolicyProperties |
InformationProtectionPolicyProperties
| Name | Description | Value |
|---|---|---|
| informationTypes | The sensitivity information types. | InformationProtectionPolicyPropertiesInformationType... |
| labels | Dictionary of sensitivity labels. | InformationProtectionPolicyPropertiesLabels |
InformationProtectionPolicyPropertiesInformationType...
| Name | Description | Value |
|---|---|---|
| {customized property} | InformationType |
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}$ |
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 |
InformationProtectionPolicyPropertiesLabels
| Name | Description | Value |
|---|---|---|
| {customized property} | SensitivityLabel |
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" |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for