Sensitivity Settings - Create Or Update

Szolgáltatás:

Defender for Cloud

API-verzió:

2023-02-15-preview

Bizalmas adatfelderítés adatérzékenység-beállításainak létrehozása vagy frissítése

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
api-version	query	True	string	API-verzió a művelethez

Kérelem törzse

Name	Kötelező	Típus	Description
sensitiveInfoTypesIds	True	string[] (uuid)	A kiválasztott bizalmas információtípusok azonosítóinak listája.
sensitivityThresholdLabelId		string (uuid)	A bizalmassági küszöbérték címkéjének azonosítója. A rangsorban szereplő vagy annál magasabb címkéket bizalmasnak tekintjük.
sensitivityThresholdLabelOrder		number	A bizalmassági küszöbérték címkéjének sorrendje. A fenti sorrendben lévő vagy feletti címkék bizalmasnak minősülnek. Ha -1 értékre van állítva, a címkék szerinti bizalmasság ki van kapcsolva

Válaszok

Name	Típus	Description
200 OK	GetSensitivitySettingsResponse	A bizalmassági beállítások frissítésének sikeressége
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Update sensitivity settings

Mintakérelem

HTTP

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

{
  "sensitiveInfoTypesIds": [
    "f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb",
    "b452f22b-f87d-4f48-8490-ecf0873325b5",
    "d59ee8b6-2618-404b-a5e7-aa377cd67543"
  ],
  "sensitivityThresholdLabelOrder": 2,
  "sensitivityThresholdLabelId": "f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb"
}

Java

import com.azure.resourcemanager.security.models.UpdateSensitivitySettingsRequest;
import java.util.Arrays;
import java.util.UUID;

/**
 * Samples for SensitivitySettings CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/examples/
     * SensitivitySettings/PutSensitivitySettings_example.json
     */
    /**
     * Sample code: Update sensitivity settings.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void updateSensitivitySettings(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.sensitivitySettings().createOrUpdateWithResponse(
            new UpdateSensitivitySettingsRequest()
                .withSensitiveInfoTypesIds(Arrays.asList(UUID.fromString("f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb"),
                    UUID.fromString("b452f22b-f87d-4f48-8490-ecf0873325b5"),
                    UUID.fromString("d59ee8b6-2618-404b-a5e7-aa377cd67543")))
                .withSensitivityThresholdLabelOrder(2.0F).withSensitivityThresholdLabelId(
                    UUID.fromString("f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb")),
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python put_sensitivity_settings_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityCenter(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.sensitivity_settings.create_or_update(
        sensitivity_settings={
            "sensitiveInfoTypesIds": [
                "f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb",
                "b452f22b-f87d-4f48-8490-ecf0873325b5",
                "d59ee8b6-2618-404b-a5e7-aa377cd67543",
            ],
            "sensitivityThresholdLabelId": "f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb",
            "sensitivityThresholdLabelOrder": 2,
        },
    )
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/examples/SensitivitySettings/PutSensitivitySettings_example.json
if __name__ == "__main__":
    main()

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

Go

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/2023-02-15-preview/examples/SensitivitySettings/PutSensitivitySettings_example.json
func ExampleSensitivitySettingsClient_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.NewSensitivitySettingsClient().CreateOrUpdate(ctx, armsecurity.UpdateSensitivitySettingsRequest{
		SensitiveInfoTypesIDs: []*string{
			to.Ptr("f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb"),
			to.Ptr("b452f22b-f87d-4f48-8490-ecf0873325b5"),
			to.Ptr("d59ee8b6-2618-404b-a5e7-aa377cd67543")},
		SensitivityThresholdLabelID:    to.Ptr("f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb"),
		SensitivityThresholdLabelOrder: to.Ptr[float32](2),
	}, 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](2),
	// 		},
	// 	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Updates data sensitivity settings for sensitive data discovery
 *
 * @summary Updates data sensitivity settings for sensitive data discovery
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/examples/SensitivitySettings/PutSensitivitySettings_example.json
 */
async function updateSensitivitySettings() {
  const sensitivitySettings = {
    sensitiveInfoTypesIds: [
      "f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb",
      "b452f22b-f87d-4f48-8490-ecf0873325b5",
      "d59ee8b6-2618-404b-a5e7-aa377cd67543",
    ],
    sensitivityThresholdLabelId: "f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb",
    sensitivityThresholdLabelOrder: 2,
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.updateSensitivitySettings(sensitivitySettings);
  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

dotnet

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

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-15-preview/examples/SensitivitySettings/PutSensitivitySettings_example.json
// this example is just showing the usage of "UpdateSensitivitySettings" 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
SensitivitySettingCreateOrUpdateContent content = new SensitivitySettingCreateOrUpdateContent(new Guid[] { Guid.Parse("f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb"), Guid.Parse("b452f22b-f87d-4f48-8490-ecf0873325b5"), Guid.Parse("d59ee8b6-2618-404b-a5e7-aa377cd67543") })
{
    SensitivityThresholdLabelOrder = 2,
    SensitivityThresholdLabelId = Guid.Parse("f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb"),
};
ArmOperation<SensitivitySettingResource> lro = await sensitivitySetting.CreateOrUpdateAsync(WaitUntil.Completed, content);
SensitivitySettingResource result = lro.Value;

// 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

Mintaválasz

Állapotkód:

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": 2,
    "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"
        }
      ]
    }
  }
}

Definíciók

Name	Description
BuiltInInfoType	Előre konfigurált bizalmas információtípus
CloudError	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
CloudErrorBody	A hiba részletei.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
GetSensitivitySettingsResponse	Bizalmassági beállítások bizalmas adatok felderítéséhez
InfoType	Egyéni felhasználó által definiált információtípus
Label	A Microsoft information protection bizalmassági címkéje
MipInformation	A Microsoft Information Protection beépített és egyéni információtípusai, címkéi és integrációs állapota.
MipIntegrationStatus	A Microsoft information protection integrációs állapota
Properties	A bizalmassági beállítások tulajdonságai
UpdateSensitivitySettingsRequest	Adatérzékenység-beállítások frissítésének kérése bizalmas adatok felderítéséhez

BuiltInInfoType

Objektum

Előre konfigurált bizalmas információtípus

Name	Típus	Description
id	string (uuid)	Az információtípus azonosítója
name	string	Az információtípus megjelenítendő neve
type	string	A beépített információtípus kategóriája

CloudError

Objektum

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Name	Típus	Description
error.additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
error.code	string	A hibakód.
error.details	CloudErrorBody[]	A hiba részletei.
error.message	string	A hibaüzenet.
error.target	string	A hibacél.

CloudErrorBody

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	CloudErrorBody[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

GetSensitivitySettingsResponse

Objektum

Bizalmassági beállítások bizalmas adatok felderítéséhez

Name	Típus	Description
id	string	A bizalmassági beállítások azonosítója
name	string	A bizalmassági beállítások neve
properties	Properties	A bizalmassági beállítások tulajdonságai
type	string	A bizalmassági beállítások típusa

InfoType

Objektum

Egyéni felhasználó által definiált információtípus

Name	Típus	Description
description	string	Az információtípus leírása
id	string (uuid)	Az információtípus azonosítója
name	string	Az információtípus megjelenítendő neve

Label

Objektum

A Microsoft information protection bizalmassági címkéje

Name	Típus	Description
id	string (uuid)	A címke azonosítója
name	string	A címke megjelenítendő neve
order	number	A címkéket bizalmassági szint szerint rendezi a rendszer. Minél nagyobb a címke sorrendje, annál érzékenyebb.

MipInformation

Objektum

A Microsoft Information Protection beépített és egyéni információtípusai, címkéi és integrációs állapota.

Name	Típus	Description
builtInInfoTypes	BuiltInInfoType[]	Előre konfigurált bizalmas információtípusok listája
customInfoTypes	InfoType[]	Egyéni felhasználó által definiált adattípusok listája
labels	Label[]	A Microsoft information protection bizalmassági címkéinek listája
mipIntegrationStatus	MipIntegrationStatus	A Microsoft information protection integrációs állapota

MipIntegrationStatus

Enumerálás

A Microsoft information protection integrációs állapota

Érték	Description
Ok
noConsent
noAutoLabelingRules
noMipLabels

Properties

Objektum

A bizalmassági beállítások tulajdonságai

Name	Típus	Description
mipInformation	MipInformation	A Microsoft Information Protection beépített és egyéni információtípusai, címkéi és integrációs állapota.
sensitiveInfoTypesIds	string[] (uuid)	A kiválasztott bizalmas információtípusok azonosítóinak listája.
sensitivityThresholdLabelId	string (uuid)	A bizalmassági küszöbérték címkéjének azonosítója. A rangsorban szereplő vagy annál magasabb címkéket bizalmasnak tekintjük.
sensitivityThresholdLabelOrder	number	A bizalmassági küszöbérték címkéjének sorrendje. A fenti sorrendben lévő vagy feletti címkék bizalmasnak minősülnek. Ha -1 értékre van állítva, a címkék szerinti bizalmasság ki van kapcsolva

UpdateSensitivitySettingsRequest

Objektum

Adatérzékenység-beállítások frissítésének kérése bizalmas adatok felderítéséhez

Name	Típus	Description
sensitiveInfoTypesIds	string[] (uuid)	A kiválasztott bizalmas információtípusok azonosítóinak listája.
sensitivityThresholdLabelId	string (uuid)	A bizalmassági küszöbérték címkéjének azonosítója. A rangsorban szereplő vagy annál magasabb címkéket bizalmasnak tekintjük.
sensitivityThresholdLabelOrder	number	A bizalmassági küszöbérték címkéjének sorrendje. A fenti sorrendben lévő vagy feletti címkék bizalmasnak minősülnek. Ha -1 értékre van állítva, a címkék szerinti bizalmasság ki van kapcsolva