Information Protection Policies - Get

サービス:: Defender for Cloud

API バージョン:: 2017-08-01-preview

情報保護ポリシーの詳細。

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

URI パラメーター

名前	/	必須	型	説明
informationProtectionPolicyName	path	True	InformationProtectionPolicyName	情報保護ポリシーの名前。
scope	path	True	string	リソースの完全資格を持つAzureリソースマネージャー識別子。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	InformationProtectionPolicy	Azureの運用は無事に完了しました。
Other Status Codes	Common.CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Get the customized information protection policy for a management group

Get the effective information protection policy for a management group

Get the customized information protection policy for a management group

要求のサンプル

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

package armsecurity_test

import (
	"context"
	"log"

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

// Generated from example definition: 2017-08-01-preview/InformationProtectionPolicies/GetCustomInformationProtectionPolicy_example.json
func ExampleInformationProtectionPoliciesClient_Get_getTheCustomizedInformationProtectionPolicyForAManagementGroup() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInformationProtectionPoliciesClient().Get(ctx, "providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e", armsecurity.InformationProtectionPolicyNameCustom, 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 = armsecurity.InformationProtectionPoliciesClientGetResponse{
	// 	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: 2017-08-01-preview/InformationProtectionPolicies/GetCustomInformationProtectionPolicy_example.json
 */
async function getTheCustomizedInformationProtectionPolicyForAManagementGroup() {
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.informationProtectionPolicies.get(
    "providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e",
    "custom",
  );
  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

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

Get the effective information protection policy for a management group

要求のサンプル

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

package armsecurity_test

import (
	"context"
	"log"

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

// Generated from example definition: 2017-08-01-preview/InformationProtectionPolicies/GetEffectiveInformationProtectionPolicy_example.json
func ExampleInformationProtectionPoliciesClient_Get_getTheEffectiveInformationProtectionPolicyForAManagementGroup() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscriptionID>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewInformationProtectionPoliciesClient().Get(ctx, "providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e", armsecurity.InformationProtectionPolicyNameEffective, 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 = armsecurity.InformationProtectionPoliciesClientGetResponse{
	// 	InformationProtectionPolicy: armsecurity.InformationProtectionPolicy{
	// 		Name: to.Ptr("effective"),
	// 		Type: to.Ptr("Microsoft.Security/informationProtectionPolicies"),
	// 		ID: to.Ptr("/providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e/providers/Microsoft.Security/informationProtectionPolicies/effective"),
	// 		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(false),
	// 							Custom: to.Ptr(true),
	// 							Pattern: to.Ptr("%networking%"),
	// 						},
	// 					},
	// 					Order: to.Ptr[int32](1400),
	// 					RecommendedLabelID: to.Ptr("7aa516c7-5a53-4857-bc6e-6808c6acd542"),
	// 				},
	// 				"5856f35c-8e08-4d08-9bf7-87a146150569": &armsecurity.InformationType{
	// 					Custom: to.Ptr(false),
	// 					DisplayName: to.Ptr("Contact Info"),
	// 					Enabled: to.Ptr(true),
	// 					Keywords: []*armsecurity.InformationProtectionKeyword{
	// 						{
	// 							CanBeNumeric: to.Ptr(false),
	// 							Custom: to.Ptr(false),
	// 							Pattern: to.Ptr("%email%"),
	// 						},
	// 						{
	// 							CanBeNumeric: to.Ptr(false),
	// 							Custom: to.Ptr(false),
	// 							Pattern: to.Ptr("%e-mail%"),
	// 						},
	// 						{
	// 							CanBeNumeric: to.Ptr(false),
	// 							Custom: to.Ptr(false),
	// 							Pattern: to.Ptr("%addr%"),
	// 						},
	// 						{
	// 							CanBeNumeric: to.Ptr(true),
	// 							Custom: to.Ptr(false),
	// 							Pattern: to.Ptr("%street%"),
	// 						},
	// 						{
	// 							CanBeNumeric: to.Ptr(false),
	// 							Custom: to.Ptr(false),
	// 							Pattern: to.Ptr("%city%"),
	// 						},
	// 					},
	// 					Order: to.Ptr[int32](200),
	// 					RecommendedLabelID: to.Ptr("575739d2-3d53-4df0-9042-4c7772d5c7b1"),
	// 				},
	// 				"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(false),
	// 							Pattern: to.Ptr("%ip%"),
	// 						},
	// 						{
	// 							CanBeNumeric: to.Ptr(false),
	// 							Custom: to.Ptr(false),
	// 							Pattern: to.Ptr("ip%address%"),
	// 						},
	// 						{
	// 							CanBeNumeric: to.Ptr(false),
	// 							Custom: to.Ptr(false),
	// 							Pattern: to.Ptr("%mac%address%"),
	// 						},
	// 						{
	// 							CanBeNumeric: to.Ptr(true),
	// 							Custom: to.Ptr(true),
	// 							Excluded: 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: 2017-08-01-preview/InformationProtectionPolicies/GetEffectiveInformationProtectionPolicy_example.json
 */
async function getTheEffectiveInformationProtectionPolicyForAManagementGroup() {
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.informationProtectionPolicies.get(
    "providers/Microsoft.Management/managementGroups/148059f7-faf3-49a6-ba35-85122112291e",
    "effective",
  );
  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

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

定義

名前	説明
Common.CloudError	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
Common.CloudErrorBody	エラーの詳細。
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
InformationProtectionKeyword	情報型のキーワード。
InformationProtectionPolicy	情報保護ポリシー。
InformationProtectionPolicyName	情報保護ポリシーの名前。
InformationType	情報の種類。
Rank	秘密度ラベルのランク。
SensitivityLabel	秘密度ラベル。
systemData	リソースの作成と最後の変更に関連するメタデータ。

Common.CloudError

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error.additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
error.code	string	エラーコード。
error.details	Common.CloudErrorBody[]	エラーの詳細。
error.message	string	エラーメッセージ。
error.target	string	エラーターゲット。

Common.CloudErrorBody

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	Common.CloudErrorBody[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

InformationProtectionKeyword

Object

情報型のキーワード。

名前	型	説明
canBeNumeric	boolean	数値型にキーワードを適用できるかどうかを示します。
custom	boolean	キーワードがカスタムかどうかを示します。
excluded	boolean	キーワードが除外されているかどうかを示します。
pattern	string	キーワードパターン。

InformationProtectionPolicy

Object

情報保護ポリシー。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.informationTypes	<string, InformationType>	秘密度情報の種類。
properties.labels	<string, SensitivityLabel>	秘密度ラベルの辞書。
properties.lastModifiedUtc	string (date-time)	ポリシーが最後に変更された UTC 時刻について説明します。
properties.version	string	ポリシーのバージョンについて説明します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

InformationProtectionPolicyName

列挙

情報保護ポリシーの名前。

値	説明
effective	効果的
custom	custom

InformationType

Object

情報の種類。

名前	型	説明
custom	boolean	情報の種類がカスタムかどうかを示します。
description	string	情報の種類の説明。
displayName	string	情報の種類の名前。
enabled	boolean	情報の種類が有効かどうかを示します。
keywords	InformationProtectionKeyword[]	情報型のキーワード。
order	integer (int32)	情報の種類の順序。
recommendedLabelId	string (uuid)	この情報の種類に関連付ける推奨ラベル ID。

Rank

列挙

秘密度ラベルのランク。

値	説明
None	None
Low	低
Medium	中程度
High	High
Critical	危うい

SensitivityLabel

Object

秘密度ラベル。

名前	型	説明
description	string	秘密度ラベルの説明。
displayName	string	秘密度ラベルの名前。
enabled	boolean	ラベルが有効かどうかを示します。
order	integer (int32)	秘密度ラベルの順序。
rank	Rank	秘密度ラベルのランク。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。