Information Protection Policies - Create Or Update

Reference

Service:: Defender for Cloud

API Version:: 2017-08-01-preview

Details of the information protection policy.

PUT https://management.azure.com/{scope}/providers/Microsoft.Security/informationProtectionPolicies/{informationProtectionPolicyName}?api-version=2017-08-01-preview

URI Parameters

Name	In	Required	Type	Description
informationProtectionPolicyName	path	True	InformationProtectionPolicyName	Name of the information protection policy.
scope	path	True	string	Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
api-version	query	True	string	API version for the operation

Request Body

Name	Type	Description
properties.informationTypes	<string, InformationType>	The sensitivity information types.
properties.labels	<string, SensitivityLabel>	Dictionary of sensitivity labels.

Responses

Name	Type	Description
200 OK	InformationProtectionPolicy	OK
201 Created	InformationProtectionPolicy	Created
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Create or update an information protection policy for a management group

Sample request

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/custom?api-version=2017-08-01-preview

{
  "properties": {
    "labels": {
      "1345da73-bc5a-4a8f-b7dd-3820eb713da8": {
        "displayName": "Public",
        "order": 100,
        "enabled": true
      },
      "7aa516c7-5a53-4857-bc6e-6808c6acd542": {
        "displayName": "General",
        "order": 200,
        "enabled": true
      },
      "575739d2-3d53-4df0-9042-4c7772d5c7b1": {
        "displayName": "Confidential",
        "order": 300,
        "enabled": true
      }
    },
    "informationTypes": {
      "7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": {
        "displayName": "Networking",
        "order": 100,
        "recommendedLabelId": "575739d2-3d53-4df0-9042-4c7772d5c7b1",
        "enabled": true,
        "custom": false,
        "keywords": [
          {
            "pattern": "%networking%",
            "custom": true,
            "canBeNumeric": false
          }
        ]
      },
      "3bf35491-99b8-41f2-86d5-c1200a7df658": {
        "displayName": "Custom",
        "order": 1400,
        "recommendedLabelId": "7aa516c7-5a53-4857-bc6e-6808c6acd542",
        "enabled": true,
        "custom": true,
        "keywords": [
          {
            "pattern": "%custom%",
            "custom": true,
            "canBeNumeric": true
          }
        ]
      }
    }
  }
}


import com.azure.resourcemanager.security.models.InformationProtectionKeyword;
import com.azure.resourcemanager.security.models.InformationProtectionPolicyName;
import com.azure.resourcemanager.security.models.InformationType;
import com.azure.resourcemanager.security.models.SensitivityLabel;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

/**
 * Samples for InformationProtectionPolicies CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/
     * InformationProtectionPolicies/CreateOrUpdateInformationProtectionPolicy_example.json
     */
    /**
     * Sample code: Create or update an information protection policy for a management group.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createOrUpdateAnInformationProtectionPolicyForAManagementGroup(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.informationProtectionPolicies().define(InformationProtectionPolicyName.CUSTOM)
            .withExistingScope("providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e")
            .withLabels(
                mapOf("1345da73-bc5a-4a8f-b7dd-3820eb713da8",
                    new SensitivityLabel().withDisplayName("Public").withOrder(100).withEnabled(true),
                    "575739d2-3d53-4df0-9042-4c7772d5c7b1",
                    new SensitivityLabel().withDisplayName("Confidential").withOrder(300).withEnabled(true),
                    "7aa516c7-5a53-4857-bc6e-6808c6acd542", new SensitivityLabel().withDisplayName("General")
                        .withOrder(200).withEnabled(true)))
            .withInformationTypes(mapOf("3bf35491-99b8-41f2-86d5-c1200a7df658",
                new InformationType().withDisplayName("Custom").withOrder(1400)
                    .withRecommendedLabelId(UUID.fromString("7aa516c7-5a53-4857-bc6e-6808c6acd542")).withEnabled(true)
                    .withCustom(true)
                    .withKeywords(Arrays.asList(new InformationProtectionKeyword()
                        .withPattern("%custom%").withCustom(true).withCanBeNumeric(true))),
                "7fb9419d-2473-4ad8-8e11-b25cc8cf6a07",
                new InformationType().withDisplayName("Networking").withOrder(100)
                    .withRecommendedLabelId(UUID.fromString("575739d2-3d53-4df0-9042-4c7772d5c7b1")).withEnabled(true)
                    .withCustom(false).withKeywords(Arrays.asList(new InformationProtectionKeyword()
                        .withPattern("%networking%").withCustom(true).withCanBeNumeric(false)))))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/InformationProtectionPolicies/CreateOrUpdateInformationProtectionPolicy_example.json
func ExampleInformationProtectionPoliciesClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInformationProtectionPoliciesClient().CreateOrUpdate(ctx, "providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e", armsecurity.InformationProtectionPolicyNameCustom, armsecurity.InformationProtectionPolicy{
		Properties: &armsecurity.InformationProtectionPolicyProperties{
			InformationTypes: map[string]*armsecurity.InformationType{
				"3bf35491-99b8-41f2-86d5-c1200a7df658": {
					Custom:      to.Ptr(true),
					DisplayName: to.Ptr("Custom"),
					Enabled:     to.Ptr(true),
					Keywords: []*armsecurity.InformationProtectionKeyword{
						{
							CanBeNumeric: to.Ptr(true),
							Custom:       to.Ptr(true),
							Pattern:      to.Ptr("%custom%"),
						}},
					Order:              to.Ptr[int32](1400),
					RecommendedLabelID: to.Ptr("7aa516c7-5a53-4857-bc6e-6808c6acd542"),
				},
				"7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": {
					Custom:      to.Ptr(false),
					DisplayName: to.Ptr("Networking"),
					Enabled:     to.Ptr(true),
					Keywords: []*armsecurity.InformationProtectionKeyword{
						{
							CanBeNumeric: to.Ptr(false),
							Custom:       to.Ptr(true),
							Pattern:      to.Ptr("%networking%"),
						}},
					Order:              to.Ptr[int32](100),
					RecommendedLabelID: to.Ptr("575739d2-3d53-4df0-9042-4c7772d5c7b1"),
				},
			},
			Labels: map[string]*armsecurity.SensitivityLabel{
				"1345da73-bc5a-4a8f-b7dd-3820eb713da8": {
					DisplayName: to.Ptr("Public"),
					Enabled:     to.Ptr(true),
					Order:       to.Ptr[int32](100),
				},
				"575739d2-3d53-4df0-9042-4c7772d5c7b1": {
					DisplayName: to.Ptr("Confidential"),
					Enabled:     to.Ptr(true),
					Order:       to.Ptr[int32](300),
				},
				"7aa516c7-5a53-4857-bc6e-6808c6acd542": {
					DisplayName: to.Ptr("General"),
					Enabled:     to.Ptr(true),
					Order:       to.Ptr[int32](200),
				},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.InformationProtectionPolicy = armsecurity.InformationProtectionPolicy{
	// 	Name: to.Ptr("custom"),
	// 	Type: to.Ptr("Microsoft.Security/informationProtectionPolicies"),
	// 	ID: to.Ptr("/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/custom"),
	// 	Properties: &armsecurity.InformationProtectionPolicyProperties{
	// 		InformationTypes: map[string]*armsecurity.InformationType{
	// 			"3bf35491-99b8-41f2-86d5-c1200a7df658": &armsecurity.InformationType{
	// 				Custom: to.Ptr(true),
	// 				DisplayName: to.Ptr("Custom"),
	// 				Enabled: to.Ptr(true),
	// 				Keywords: []*armsecurity.InformationProtectionKeyword{
	// 					{
	// 						CanBeNumeric: to.Ptr(true),
	// 						Custom: to.Ptr(true),
	// 						Pattern: to.Ptr("%custom%"),
	// 				}},
	// 				Order: to.Ptr[int32](1400),
	// 				RecommendedLabelID: to.Ptr("7aa516c7-5a53-4857-bc6e-6808c6acd542"),
	// 			},
	// 			"7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": &armsecurity.InformationType{
	// 				Custom: to.Ptr(false),
	// 				DisplayName: to.Ptr("Networking"),
	// 				Enabled: to.Ptr(true),
	// 				Keywords: []*armsecurity.InformationProtectionKeyword{
	// 					{
	// 						CanBeNumeric: to.Ptr(false),
	// 						Custom: to.Ptr(true),
	// 						Pattern: to.Ptr("%networking%"),
	// 				}},
	// 				Order: to.Ptr[int32](100),
	// 				RecommendedLabelID: to.Ptr("575739d2-3d53-4df0-9042-4c7772d5c7b1"),
	// 			},
	// 		},
	// 		Labels: map[string]*armsecurity.SensitivityLabel{
	// 			"1345da73-bc5a-4a8f-b7dd-3820eb713da8": &armsecurity.SensitivityLabel{
	// 				DisplayName: to.Ptr("Public"),
	// 				Enabled: to.Ptr(true),
	// 				Order: to.Ptr[int32](100),
	// 			},
	// 			"575739d2-3d53-4df0-9042-4c7772d5c7b1": &armsecurity.SensitivityLabel{
	// 				DisplayName: to.Ptr("Confidential"),
	// 				Enabled: to.Ptr(true),
	// 				Order: to.Ptr[int32](300),
	// 			},
	// 			"7aa516c7-5a53-4857-bc6e-6808c6acd542": &armsecurity.SensitivityLabel{
	// 				DisplayName: to.Ptr("General"),
	// 				Enabled: to.Ptr(true),
	// 				Order: to.Ptr[int32](200),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Details of the information protection policy.
 *
 * @summary Details of the information protection policy.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/InformationProtectionPolicies/CreateOrUpdateInformationProtectionPolicy_example.json
 */
async function createOrUpdateAnInformationProtectionPolicyForAManagementGroup() {
  const scope =
    "providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e";
  const informationProtectionPolicyName = "custom";
  const informationProtectionPolicy = {
    informationTypes: {
      "3bf3549199b841f286d5C1200a7df658": {
        custom: true,
        displayName: "Custom",
        enabled: true,
        keywords: [{ canBeNumeric: true, custom: true, pattern: "%custom%" }],
        order: 1400,
        recommendedLabelId: "7aa516c7-5a53-4857-bc6e-6808c6acd542",
      },
      "7fb9419d24734ad88e11B25cc8cf6a07": {
        custom: false,
        displayName: "Networking",
        enabled: true,
        keywords: [{ canBeNumeric: false, custom: true, pattern: "%networking%" }],
        order: 100,
        recommendedLabelId: "575739d2-3d53-4df0-9042-4c7772d5c7b1",
      },
    },
    labels: {
      "1345da73Bc5a4a8fB7dd3820eb713da8": {
        displayName: "Public",
        enabled: true,
        order: 100,
      },
      "575739d23d534df090424c7772d5c7b1": {
        displayName: "Confidential",
        enabled: true,
        order: 300,
      },
      "7aa516c75a534857Bc6e6808c6acd542": {
        displayName: "General",
        enabled: true,
        order: 200,
      },
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.informationProtectionPolicies.createOrUpdate(
    scope,
    informationProtectionPolicyName,
    informationProtectionPolicy,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/custom",
  "name": "custom",
  "type": "Microsoft.Security/informationProtectionPolicies",
  "properties": {
    "labels": {
      "1345da73-bc5a-4a8f-b7dd-3820eb713da8": {
        "displayName": "Public",
        "order": 100,
        "enabled": true
      },
      "7aa516c7-5a53-4857-bc6e-6808c6acd542": {
        "displayName": "General",
        "order": 200,
        "enabled": true
      },
      "575739d2-3d53-4df0-9042-4c7772d5c7b1": {
        "displayName": "Confidential",
        "order": 300,
        "enabled": true
      }
    },
    "informationTypes": {
      "7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": {
        "displayName": "Networking",
        "order": 100,
        "recommendedLabelId": "575739d2-3d53-4df0-9042-4c7772d5c7b1",
        "enabled": true,
        "custom": false,
        "keywords": [
          {
            "pattern": "%networking%",
            "custom": true,
            "canBeNumeric": false
          }
        ]
      },
      "3bf35491-99b8-41f2-86d5-c1200a7df658": {
        "displayName": "Custom",
        "order": 1400,
        "recommendedLabelId": "7aa516c7-5a53-4857-bc6e-6808c6acd542",
        "enabled": true,
        "custom": true,
        "keywords": [
          {
            "pattern": "%custom%",
            "custom": true,
            "canBeNumeric": true
          }
        ]
      }
    }
  }
}

Status code:: 201

{
  "id": "/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/custom",
  "name": "custom",
  "type": "Microsoft.Security/informationProtectionPolicies",
  "properties": {
    "labels": {
      "1345da73-bc5a-4a8f-b7dd-3820eb713da8": {
        "displayName": "Public",
        "order": 100,
        "enabled": true
      },
      "7aa516c7-5a53-4857-bc6e-6808c6acd542": {
        "displayName": "General",
        "order": 200,
        "enabled": true
      },
      "575739d2-3d53-4df0-9042-4c7772d5c7b1": {
        "displayName": "Confidential",
        "order": 300,
        "enabled": true
      }
    },
    "informationTypes": {
      "7fb9419d-2473-4ad8-8e11-b25cc8cf6a07": {
        "displayName": "Networking",
        "order": 100,
        "recommendedLabelId": "575739d2-3d53-4df0-9042-4c7772d5c7b1",
        "enabled": true,
        "custom": false,
        "keywords": [
          {
            "pattern": "%networking%",
            "custom": true,
            "canBeNumeric": false
          }
        ]
      },
      "3bf35491-99b8-41f2-86d5-c1200a7df658": {
        "displayName": "Custom",
        "order": 1400,
        "recommendedLabelId": "7aa516c7-5a53-4857-bc6e-6808c6acd542",
        "enabled": true,
        "custom": true,
        "keywords": [
          {
            "pattern": "%custom%",
            "custom": true,
            "canBeNumeric": true
          }
        ]
      }
    }
  }
}

Definitions

Name	Description
CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
CloudErrorBody	The error detail.
ErrorAdditionalInfo	The resource management error additional info.
InformationProtectionKeyword	The information type keyword.
InformationProtectionPolicy	Information protection policy.
InformationProtectionPolicyName	Name of the information protection policy.
InformationType	The information type.
rank	The rank of the sensitivity label.
SensitivityLabel	The sensitivity label.

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

CloudErrorBody

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

InformationProtectionKeyword

The information type keyword.

Name	Type	Description
canBeNumeric	boolean	Indicates whether the keyword can be applied on numeric types or not.
custom	boolean	Indicates whether the keyword is custom or not.
excluded	boolean	Indicates whether the keyword is excluded or not.
pattern	string	The keyword pattern.

InformationProtectionPolicy

Information protection policy.

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.informationTypes	<string, InformationType>	The sensitivity information types.
properties.labels	<string, SensitivityLabel>	Dictionary of sensitivity labels.
properties.lastModifiedUtc	string	Describes the last UTC time the policy was modified.
properties.version	string	Describes the version of the policy.
type	string	Resource type

InformationProtectionPolicyName

Name of the information protection policy.

Name	Type	Description
custom	string
effective	string

InformationType

The information type.

Name	Type	Description
custom	boolean	Indicates whether the information type is custom or not.
description	string	The description of the information type.
displayName	string	The name of the information type.
enabled	boolean	Indicates whether the information type is enabled or not.
keywords	InformationProtectionKeyword[]	The information type keywords.
order	integer	The order of the information type.
recommendedLabelId	string	The recommended label id to be associated with this information type.

rank

The rank of the sensitivity label.

Name	Type	Description
Critical	string
High	string
Low	string
Medium	string
None	string

SensitivityLabel

The sensitivity label.

Name	Type	Description
description	string	The description of the sensitivity label.
displayName	string	The name of the sensitivity label.
enabled	boolean	Indicates whether the label is enabled or not.
order	integer	The order of the sensitivity label.
rank	rank	The rank of the sensitivity label.

Share via

Information Protection Policies - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Create or update an information protection policy for a management group

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

ErrorAdditionalInfo

InformationProtectionKeyword

InformationProtectionPolicy

InformationProtectionPolicyName

InformationType

rank

SensitivityLabel

Additional resources