Sensitivity Settings - Create Or Update

Dienst:: Defender for Cloud

API-Version:: 2023-02-15-preview

Erstellen oder Aktualisieren von Vertraulichkeitseinstellungen für vertrauliche Datenermittlung

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
sensitiveInfoTypesIds	True	string[] (uuid)	Liste der ausgewählten IDs vertraulicher Informationstypen.
sensitivityThresholdLabelId		string (uuid)	Die ID der Vertraulichkeitsschwellenbezeichnung. Jede Beschriftung in oder höher dieser Rangfolge wird als vertraulich betrachtet.
sensitivityThresholdLabelOrder		number (float)	Die Reihenfolge der Vertraulichkeitsschwellenbezeichnung. Jede Bezeichnung in oder höher dieser Reihenfolge wird als vertraulich betrachtet. Bei Festlegung auf -1 ist die Vertraulichkeit durch Bezeichnungen deaktiviert.

Antworten

Name	Typ	Beschreibung
200 OK	GetSensitivitySettingsResponse	Die Aktualisierungsoperation der Ressource 'GetSensitivitySettingsResponse' war erfolgreich
Other Status Codes	Common.CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Update sensitivity settings

Beispielanforderung

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"
  ],
  "sensitivityThresholdLabelId": "f2f8a7a1-28c0-404b-9ab4-30a0a7af18cb",
  "sensitivityThresholdLabelOrder": 2
}

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: 2023-02-15-preview/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("<subscriptionID>", 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 = armsecurity.SensitivitySettingsClientCreateOrUpdateResponse{
	// 	GetSensitivitySettingsResponse: armsecurity.GetSensitivitySettingsResponse{
	// 		Name: to.Ptr("current"),
	// 		Type: to.Ptr("Microsoft.Security/sensitivitySettings"),
	// 		ID: to.Ptr("/providers/Microsoft.Security/sensitivitySettings/current"),
	// 		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

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

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "current",
  "type": "Microsoft.Security/sensitivitySettings",
  "id": "/providers/Microsoft.Security/sensitivitySettings/current",
  "properties": {
    "mipInformation": {
      "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"
        }
      ],
      "customInfoTypes": [
        {
          "name": "User created custom info type 1",
          "description": "Custom info type description",
          "id": "c5f9b9a1-2b9a-4a3a-8c5b-1f3d1d9d9c9b"
        },
        {
          "name": "User created custom info type 2",
          "description": "Custom info type description",
          "id": "a4fee2b6-5618-404b-a5e7-aa377cd67543"
        },
        {
          "name": "User created custom info type 3",
          "description": "Custom info type description",
          "id": "a355f11e-f87d-4f48-8490-ecf0873325b5"
        }
      ],
      "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
        }
      ],
      "mipIntegrationStatus": "Ok"
    },
    "sensitiveInfoTypesIds": [
      "a98fde82-45b6-4b2c-afd0-ad579cd9f826",
      "4d0d3eb6-619f-4c8c-810c-c16150c95278",
      "0e9b3178-9678-47dd-a509-37222ca96b42",
      "c5f9b9a1-2b9a-4a3a-8c5b-1f3d1d9d9c9b"
    ],
    "sensitivityThresholdLabelOrder": 2
  }
}

Definitionen

Name	Beschreibung
BuiltInInfoType	Vorkonfigurierte vertraulicher Informationstyp
Common.CloudError	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
Common.CloudErrorBody	Das Fehlerdetails.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
GetSensitivitySettingsResponse	Datenschutzeinstellungen für vertrauliche Datenermittlung
GetSensitivitySettingsResponseProperties	Die Eigenschaften der Vertraulichkeitseinstellungen
GetSensitivitySettingsResponsePropertiesMipInformation	Microsoft Information Protection integrierte und benutzerdefinierte Informationstypen, Bezeichnungen und Integrationsstatus.
InfoType	Benutzerdefinierter benutzerdefinierter Informationstyp
Label	Vertraulichkeitsbezeichnung für Microsoft-Informationsschutz
MipIntegrationStatus	Integrationsstatus von Microsoft Information Protection
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UpdateSensitivitySettingsRequest	Anforderung zum Aktualisieren von Datenschutzeinstellungen für die Ermittlung vertraulicher Daten

BuiltInInfoType

Objekt

Vorkonfigurierte vertraulicher Informationstyp

Name	Typ	Beschreibung
id	string (uuid)	ID des Informationstyps
name	string	Anzeigename des Infotyps
type	string	Kategorie des integrierten Informationstyps

Common.CloudError

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error.additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
error.code	string	Der Fehlercode.
error.details	Common.CloudErrorBody[]	Die Fehlerdetails.
error.message	string	Die Fehlermeldung.
error.target	string	Das Fehlerziel.

Common.CloudErrorBody

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	Common.CloudErrorBody[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

GetSensitivitySettingsResponse

Objekt

Datenschutzeinstellungen für vertrauliche Datenermittlung

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	GetSensitivitySettingsResponseProperties	Die Eigenschaften der Vertraulichkeitseinstellungen
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

GetSensitivitySettingsResponseProperties

Objekt

Die Eigenschaften der Vertraulichkeitseinstellungen

Name	Typ	Beschreibung
mipInformation	GetSensitivitySettingsResponsePropertiesMipInformation	Microsoft Information Protection integrierte und benutzerdefinierte Informationstypen, Bezeichnungen und Integrationsstatus.
sensitiveInfoTypesIds	string[] (uuid)	Liste der ausgewählten IDs vertraulicher Informationstypen.
sensitivityThresholdLabelId	string (uuid)	Die ID der Vertraulichkeitsschwellenbezeichnung. Jede Beschriftung in oder höher dieser Rangfolge wird als vertraulich betrachtet.
sensitivityThresholdLabelOrder	number (float)	Die Reihenfolge der Vertraulichkeitsschwellenbezeichnung. Jede Bezeichnung in oder höher dieser Reihenfolge wird als vertraulich betrachtet. Bei Festlegung auf -1 ist die Vertraulichkeit durch Bezeichnungen deaktiviert.

GetSensitivitySettingsResponsePropertiesMipInformation

Objekt

Microsoft Information Protection integrierte und benutzerdefinierte Informationstypen, Bezeichnungen und Integrationsstatus.

Name	Typ	Beschreibung
builtInInfoTypes	BuiltInInfoType[]	Liste der vorkonfigurierten Typen vertraulicher Informationen
customInfoTypes	InfoType[]	Liste der benutzerdefinierten benutzerdefinierten Informationstypen
labels	Label[]	Liste der Vertraulichkeitsbezeichnungen zum Schutz von Microsoft-Informationen
mipIntegrationStatus	MipIntegrationStatus	Integrationsstatus von Microsoft Information Protection

InfoType

Objekt

Benutzerdefinierter benutzerdefinierter Informationstyp

Name	Typ	Beschreibung
description	string	Beschreibung des Infotyps
id	string (uuid)	ID des Informationstyps
name	string	Anzeigename des Infotyps

Label

Objekt

Vertraulichkeitsbezeichnung für Microsoft-Informationsschutz

Name	Typ	Beschreibung
id	string (uuid)	Die ID der Bezeichnung
name	string	Der Anzeigename der Bezeichnung
order	number (float)	Bezeichnungen werden nach Vertraulichkeitsstufe sortiert. Je höher die Reihenfolge der Bezeichnung, desto sensibler ist sie.

MipIntegrationStatus

Enumeration

Integrationsstatus von Microsoft Information Protection

Wert	Beschreibung
Ok	Okay
noConsent	noConsent
noAutoLabelingRules	noAutoLabelingRules
noMipLabels	noMipLabels

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UpdateSensitivitySettingsRequest

Objekt

Anforderung zum Aktualisieren von Datenschutzeinstellungen für die Ermittlung vertraulicher Daten

Name	Typ	Beschreibung
sensitiveInfoTypesIds	string[] (uuid)	Liste der ausgewählten IDs vertraulicher Informationstypen.
sensitivityThresholdLabelId	string (uuid)	Die ID der Vertraulichkeitsschwellenbezeichnung. Jede Beschriftung in oder höher dieser Rangfolge wird als vertraulich betrachtet.
sensitivityThresholdLabelOrder	number (float)	Die Reihenfolge der Vertraulichkeitsschwellenbezeichnung. Jede Bezeichnung in oder höher dieser Reihenfolge wird als vertraulich betrachtet. Bei Festlegung auf -1 ist die Vertraulichkeit durch Bezeichnungen deaktiviert.