Sensitivity Settings - Get

參考

服務:: Defender for Cloud

API 版本:: 2023-02-15-preview

取得敏感數據探索的數據敏感度設定

GET https://management.azure.com/providers/Microsoft.Security/sensitivitySettings/current?api-version=2023-02-15-preview

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	作業的 API 版本

回應

名稱	類型	Description
200 OK	GetSensitivitySettingsResponse	取得敏感度設定的成功
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	模擬您的用戶帳戶

範例

Get sensitivity settings

範例要求

GET https://management.azure.com/providers/Microsoft.Security/sensitivitySettings/current?api-version=2023-02-15-preview


/**
 * Samples for SensitivitySettings Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/examples/
     * SensitivitySettings/GetSensitivitySettings_example.json
     */
    /**
     * Sample code: Get sensitivity settings.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getSensitivitySettings(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.sensitivitySettings().getWithResponse(com.azure.core.util.Context.NONE);
    }
}

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/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/2023-02-15-preview/examples/SensitivitySettings/GetSensitivitySettings_example.json
func ExampleSensitivitySettingsClient_Get() {
	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.NewSensitivitySettingsClient().Get(ctx, 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.GetSensitivitySettingsResponse = armsecurity.GetSensitivitySettingsResponse{
	// 	Name: to.Ptr("current"),
	// 	Type: to.Ptr("Microsoft.Security/sensitivitySettings"),
	// 	ID: to.Ptr("/providers/Microsoft.Security/sensitivitySettings"),
	// 	Properties: &armsecurity.GetSensitivitySettingsResponseProperties{
	// 		MipInformation: &armsecurity.GetSensitivitySettingsResponsePropertiesMipInformation{
	// 			BuiltInInfoTypes: []*armsecurity.BuiltInInfoType{
	// 				{
	// 					Name: to.Ptr("Http Authorization Header"),
	// 					Type: to.Ptr("Credentials"),
	// 					ID: to.Ptr("4d0d3eb6-619f-4c8c-810c-c16150c95278"),
	// 				},
	// 				{
	// 					Name: to.Ptr("User Login Credentials"),
	// 					Type: to.Ptr("Credentials"),
	// 					ID: to.Ptr("a98fde82-45b6-4b2c-afd0-ad579cd9f826"),
	// 				},
	// 				{
	// 					Name: to.Ptr("Credit card number"),
	// 					Type: to.Ptr("Finance"),
	// 					ID: to.Ptr("50842eb7-edc8-4019-85dd-5a5c1f2bb085"),
	// 				},
	// 				{
	// 					Name: to.Ptr("EU debit card number"),
	// 					Type: to.Ptr("Finance"),
	// 					ID: to.Ptr("0e9b3178-9678-47dd-a509-37222ca96b42"),
	// 			}},
	// 			CustomInfoTypes: []*armsecurity.InfoType{
	// 				{
	// 					Name: to.Ptr("User created custom info type 1"),
	// 					Description: to.Ptr("Custom info type description"),
	// 					ID: to.Ptr("c5f9b9a1-2b9a-4a3a-8c5b-1f3d1d9d9c9b"),
	// 				},
	// 				{
	// 					Name: to.Ptr("User created custom info type 2"),
	// 					Description: to.Ptr("Custom info type description"),
	// 					ID: to.Ptr("a4fee2b6-5618-404b-a5e7-aa377cd67543"),
	// 				},
	// 				{
	// 					Name: to.Ptr("User created custom info type 3"),
	// 					Description: to.Ptr("Custom info type description"),
	// 					ID: to.Ptr("a355f11e-f87d-4f48-8490-ecf0873325b5"),
	// 			}},
	// 			Labels: []*armsecurity.Label{
	// 				{
	// 					Name: to.Ptr("Public"),
	// 					ID: to.Ptr("fdfb5435-124d-4651-a889-a4210fec6a77"),
	// 					Order: to.Ptr[float32](0),
	// 				},
	// 				{
	// 					Name: to.Ptr("Confidential"),
	// 					ID: to.Ptr("4c5447ec-f7f3-4345-a160-6a5850f2bf0c"),
	// 					Order: to.Ptr[float32](1),
	// 				},
	// 				{
	// 					Name: to.Ptr("Highly Confidential"),
	// 					ID: to.Ptr("f38ac75c-f42a-4c89-aa37-9c4e74101414"),
	// 					Order: to.Ptr[float32](2),
	// 			}},
	// 			MipIntegrationStatus: to.Ptr(armsecurity.MipIntegrationStatusOk),
	// 		},
	// 		SensitiveInfoTypesIDs: []*string{
	// 			to.Ptr("a98fde82-45b6-4b2c-afd0-ad579cd9f826"),
	// 			to.Ptr("4d0d3eb6-619f-4c8c-810c-c16150c95278"),
	// 			to.Ptr("0e9b3178-9678-47dd-a509-37222ca96b42"),
	// 			to.Ptr("c5f9b9a1-2b9a-4a3a-8c5b-1f3d1d9d9c9b")},
	// 			SensitivityThresholdLabelOrder: to.Ptr[float32](1),
	// 		},
	// 	}
}

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 Gets data sensitivity settings for sensitive data discovery
 *
 * @summary Gets data sensitivity settings for sensitive data discovery
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/examples/SensitivitySettings/GetSensitivitySettings_example.json
 */
async function getSensitivitySettings() {
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.getSensitivitySettings();
  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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/examples/SensitivitySettings/GetSensitivitySettings_example.json
// this example is just showing the usage of "GetSensitivitySettings" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SensitivitySettingResource created on azure
// for more information of creating SensitivitySettingResource, please refer to the document of SensitivitySettingResource
ResourceIdentifier sensitivitySettingResourceId = SensitivitySettingResource.CreateResourceIdentifier();
SensitivitySettingResource sensitivitySetting = client.GetSensitivitySettingResource(sensitivitySettingResourceId);

// invoke the operation
SensitivitySettingResource result = await sensitivitySetting.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SensitivitySettingData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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.Security/sensitivitySettings",
  "name": "current",
  "type": "Microsoft.Security/sensitivitySettings",
  "properties": {
    "sensitiveInfoTypesIds": [
      "a98fde82-45b6-4b2c-afd0-ad579cd9f826",
      "4d0d3eb6-619f-4c8c-810c-c16150c95278",
      "0e9b3178-9678-47dd-a509-37222ca96b42",
      "c5f9b9a1-2b9a-4a3a-8c5b-1f3d1d9d9c9b"
    ],
    "sensitivityThresholdLabelOrder": 1,
    "mipInformation": {
      "mipIntegrationStatus": "Ok",
      "labels": [
        {
          "name": "Public",
          "id": "fdfb5435-124d-4651-a889-a4210fec6a77",
          "order": 0
        },
        {
          "name": "Confidential",
          "id": "4c5447ec-f7f3-4345-a160-6a5850f2bf0c",
          "order": 1
        },
        {
          "name": "Highly Confidential",
          "id": "f38ac75c-f42a-4c89-aa37-9c4e74101414",
          "order": 2
        }
      ],
      "customInfoTypes": [
        {
          "name": "User created custom info type 1",
          "id": "c5f9b9a1-2b9a-4a3a-8c5b-1f3d1d9d9c9b",
          "description": "Custom info type description"
        },
        {
          "name": "User created custom info type 2",
          "id": "a4fee2b6-5618-404b-a5e7-aa377cd67543",
          "description": "Custom info type description"
        },
        {
          "name": "User created custom info type 3",
          "id": "a355f11e-f87d-4f48-8490-ecf0873325b5",
          "description": "Custom info type description"
        }
      ],
      "builtInInfoTypes": [
        {
          "name": "Http Authorization Header",
          "type": "Credentials",
          "id": "4d0d3eb6-619f-4c8c-810c-c16150c95278"
        },
        {
          "name": "User Login Credentials",
          "type": "Credentials",
          "id": "a98fde82-45b6-4b2c-afd0-ad579cd9f826"
        },
        {
          "name": "Credit card number",
          "type": "Finance",
          "id": "50842eb7-edc8-4019-85dd-5a5c1f2bb085"
        },
        {
          "name": "EU debit card number",
          "type": "Finance",
          "id": "0e9b3178-9678-47dd-a509-37222ca96b42"
        }
      ]
    }
  }
}

定義

名稱	Description
BuiltInInfoType	預先設定的敏感性信息類型
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
CloudErrorBody	錯誤詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
GetSensitivitySettingsResponse	敏感數據探索的數據敏感度設定
InfoType	自訂使用者定義信息類型
Label	Microsoft資訊保護敏感度標籤
MipInformation	Microsoft資訊保護內建和自定義資訊類型、標籤和整合狀態。
MipIntegrationStatus	Microsoft資訊保護整合狀態
Properties	敏感度設定屬性

BuiltInInfoType

預先設定的敏感性信息類型

名稱	類型	Description
id	string	資訊類型的識別碼
name	string	資訊類型的顯示名稱
type	string	內建資訊類型的類別

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	其他信息類型。

GetSensitivitySettingsResponse

敏感數據探索的數據敏感度設定

名稱	類型	Description
id	string	敏感度設定的標識碼
name	string	敏感度設定的名稱
properties	Properties	敏感度設定屬性
type	string	敏感度設定的類型

InfoType

自訂使用者定義信息類型

名稱	類型	Description
description	string	資訊類型的描述
id	string	資訊類型的識別碼
name	string	資訊類型的顯示名稱

Label

Microsoft資訊保護敏感度標籤

名稱	類型	Description
id	string	標籤的識別碼
name	string	標籤的顯示名稱
order	number	卷標會依敏感度層級排序。卷標的順序愈高，其敏感度就越高。

MipInformation

Microsoft資訊保護內建和自定義資訊類型、標籤和整合狀態。

名稱	類型	Description
builtInInfoTypes	BuiltInInfoType[]	預先設定的敏感性資訊類型清單
customInfoTypes	InfoType[]	自訂使用者定義資訊類型清單
labels	Label[]	Microsoft資訊保護敏感度標籤的清單
mipIntegrationStatus	MipIntegrationStatus	Microsoft資訊保護整合狀態

MipIntegrationStatus

Microsoft資訊保護整合狀態

名稱	類型	Description
Ok	string
noAutoLabelingRules	string
noConsent	string
noMipLabels	string

Properties

敏感度設定屬性

名稱	類型	Description
mipInformation	MipInformation	Microsoft資訊保護內建和自定義資訊類型、標籤和整合狀態。
sensitiveInfoTypesIds	string[]	所選敏感性資訊類型的標識符清單。
sensitivityThresholdLabelId	string	敏感度臨界值標籤的標識碼。此排名以上的任何標籤都會被視為敏感。
sensitivityThresholdLabelOrder	number	敏感度臨界值標籤的順序。此順序以上的任何標籤都會被視為敏感。如果設定為 -1，則會關閉標籤的敏感度

共用方式為

Sensitivity Settings - Get

URI 參數

回應

安全性

azure_auth

範圍

範例

Get sensitivity settings

範例要求

範例回覆

定義

BuiltInInfoType

CloudError

CloudErrorBody

ErrorAdditionalInfo

GetSensitivitySettingsResponse

InfoType

Label

MipInformation

MipIntegrationStatus

Properties

其他資源