Information Protection Policies - Create Or Update

參考

服務:: Defender for Cloud

API 版本:: 2017-08-01-preview

信息保護原則的詳細數據。

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

URI 參數

名稱	位於	必要	類型	Description
informationProtectionPolicyName	path	True	InformationProtectionPolicyName	資訊保護原則的名稱。
scope	path	True	string	查詢的範圍可以是訂用帳戶（/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f）或管理群組（/providers/Microsoft.Management/managementGroups/mgName）。
api-version	query	True	string	作業的 API 版本

要求本文

名稱	類型	Description
properties.informationTypes	<string, InformationType>	敏感度信息類型。
properties.labels	<string, SensitivityLabel>	敏感度標籤的字典。

回應

名稱	類型	Description
200 OK	InformationProtectionPolicy	還行
201 Created	InformationProtectionPolicy	創建
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Create or update an information protection policy for a management group

範例要求

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

範例回覆

狀態碼:: 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
          }
        ]
      }
    }
  }
}

狀態碼:: 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
          }
        ]
      }
    }
  }
}

定義

名稱	Description
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
CloudErrorBody	錯誤詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
InformationProtectionKeyword	資訊類型關鍵詞。
InformationProtectionPolicy	信息保護原則。
InformationProtectionPolicyName	資訊保護原則的名稱。
InformationType	信息類型。
rank	敏感度標籤的排名。
SensitivityLabel	敏感度標籤。

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error.additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
error.code	string	錯誤碼。
error.details	CloudErrorBody[]	錯誤詳細數據。
error.message	string	錯誤訊息。
error.target	string	錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	CloudErrorBody[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

InformationProtectionKeyword

資訊類型關鍵詞。

名稱	類型	Description
canBeNumeric	boolean	指出關鍵詞是否可以套用在數值類型上。
custom	boolean	指出關鍵詞是否為自定義。
excluded	boolean	指出是否排除關鍵詞。
pattern	string	關鍵詞模式。

InformationProtectionPolicy

信息保護原則。

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties.informationTypes	<string, InformationType>	敏感度信息類型。
properties.labels	<string, SensitivityLabel>	敏感度標籤的字典。
properties.lastModifiedUtc	string	描述上次修改原則的 UTC 時間。
properties.version	string	描述原則的版本。
type	string	資源類型

InformationProtectionPolicyName

資訊保護原則的名稱。

名稱	類型	Description
custom	string
effective	string

InformationType

信息類型。

名稱	類型	Description
custom	boolean	指出資訊類型是否為自定義。
description	string	資訊類型的描述。
displayName	string	資訊類型的名稱。
enabled	boolean	指出是否啟用信息類型。
keywords	InformationProtectionKeyword[]	資訊類型關鍵詞。
order	integer	資訊類型的順序。
recommendedLabelId	string	要與此資訊類型相關聯的建議標籤標識碼。

rank

敏感度標籤的排名。

名稱	類型	Description
Critical	string
High	string
Low	string
Medium	string
None	string

SensitivityLabel

敏感度標籤。

名稱	類型	Description
description	string	敏感度標籤的描述。
displayName	string	敏感度標籤的名稱。
enabled	boolean	指出是否啟用標籤。
order	integer	敏感度標籤的順序。
rank	rank	敏感度標籤的排名。

共用方式為

Information Protection Policies - Create Or Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

Create or update an information protection policy for a management group

範例要求

範例回覆

定義

CloudError

CloudErrorBody

ErrorAdditionalInfo

InformationProtectionKeyword

InformationProtectionPolicy

InformationProtectionPolicyName

InformationType

rank

SensitivityLabel

其他資源