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

Имя	В	Обязательно	Тип	Описание
api-version	query	True	string	Версия API для операции

Ответы

Имя	Тип	Описание
200 OK	GetSensitivitySettingsResponse	Успешность получения параметров конфиденциальности
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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"
        }
      ]
    }
  }
}

Определения

Имя	Описание
BuiltInInfoType	Предварительно настроенный тип конфиденциальной информации
CloudError	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
CloudErrorBody	Сведения об ошибке.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
GetSensitivitySettingsResponse	Параметры конфиденциальности данных для обнаружения конфиденциальных данных
InfoType	Настраиваемый определяемый пользователем тип информации
Label	Метка конфиденциальности защиты информации Майкрософт
MipInformation	Встроенная защита информации Майкрософт и настраиваемые типы информации, метки и состояние интеграции.
MipIntegrationStatus	Состояние интеграции с Microsoft Information Protection
Properties	Свойства параметров конфиденциальности

BuiltInInfoType

Предварительно настроенный тип конфиденциальной информации

Имя	Тип	Описание
id	string	Идентификатор типа сведений
name	string	Отображаемое имя типа сведений
type	string	Категория встроенного типа сведений

CloudError

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя	Тип	Описание
error.additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
error.code	string	Код ошибки.
error.details	CloudErrorBody[]	Сведения об ошибке.
error.message	string	Сообщение об ошибке.
error.target	string	Целевой объект ошибки.

CloudErrorBody

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	CloudErrorBody[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

GetSensitivitySettingsResponse

Параметры конфиденциальности данных для обнаружения конфиденциальных данных

Имя	Тип	Описание
id	string	Идентификатор параметров конфиденциальности
name	string	Имя параметров конфиденциальности
properties	Properties	Свойства параметров конфиденциальности
type	string	Тип параметров конфиденциальности

InfoType

Настраиваемый определяемый пользователем тип информации

Имя	Тип	Описание
description	string	Описание типа сведений
id	string	Идентификатор типа сведений
name	string	Отображаемое имя типа сведений

Label

Метка конфиденциальности защиты информации Майкрософт

Имя	Тип	Описание
id	string	Идентификатор метки
name	string	Отображаемое имя метки
order	number	Метки упорядочены по уровню конфиденциальности. Чем выше порядок метки, тем более чувствительным он является.

MipInformation

Встроенная защита информации Майкрософт и настраиваемые типы информации, метки и состояние интеграции.

Имя	Тип	Описание
builtInInfoTypes	BuiltInInfoType[]	Список предварительно настроенных типов конфиденциальной информации
customInfoTypes	InfoType[]	Список пользовательских типов сведений
labels	Label[]	Список меток конфиденциальности защиты информации Майкрософт
mipIntegrationStatus	MipIntegrationStatus	Состояние интеграции с Microsoft Information Protection

MipIntegrationStatus

Состояние интеграции с Microsoft Information Protection

Имя	Тип	Описание
Ok	string
noAutoLabelingRules	string
noConsent	string
noMipLabels	string

Properties

Свойства параметров конфиденциальности

Имя	Тип	Описание
mipInformation	MipInformation	Встроенная защита информации Майкрософт и настраиваемые типы информации, метки и состояние интеграции.
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

Дополнительные ресурсы