Sensitivity Settings - Create Or Update

Service:: Defender for Cloud

API Version:: 2023-02-15-preview

Create or update data sensitivity settings for sensitive data discovery

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

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
sensitiveInfoTypesIds	True	string[] (uuid)	List of selected sensitive info types' IDs.
sensitivityThresholdLabelId		string (uuid)	The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.
sensitivityThresholdLabelOrder		number (float)	The order of the sensitivity threshold label. Any label at or above this order will be considered sensitive. If set to -1, sensitivity by labels is turned off

Responses

Name	Type	Description
200 OK	GetSensitivitySettingsResponse	Resource 'GetSensitivitySettingsResponse' update operation succeeded
Other Status Codes	Common.CloudError	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Update sensitivity settings

Sample request

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

Sample response

Status code:: 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
  }
}

Definitions

Name	Description
BuiltInInfoType	Pre-configured sensitive information type
Common.CloudError	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Common.CloudErrorBody	The error detail.
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
GetSensitivitySettingsResponse	Data sensitivity settings for sensitive data discovery
GetSensitivitySettingsResponseProperties	The sensitivity settings properties
GetSensitivitySettingsResponsePropertiesMipInformation	Microsoft information protection built-in and custom information types, labels, and integration status.
InfoType	Custom user-defined information type
Label	Microsoft information protection sensitivity label
MipIntegrationStatus	Microsoft information protection integration status
systemData	Metadata pertaining to creation and last modification of the resource.
UpdateSensitivitySettingsRequest	Request to update data sensitivity settings for sensitive data discovery

BuiltInInfoType

Object

Pre-configured sensitive information type

Name	Type	Description
id	string (uuid)	Id of the info type
name	string	Display name of the info type
type	string	Category of the built-in info type

Common.CloudError

Object

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	The error additional info.
error.code	string	The error code.
error.details	Common.CloudErrorBody[]	The error details.
error.message	string	The error message.
error.target	string	The error target.

Common.CloudErrorBody

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	Common.CloudErrorBody[]	The error details.
message	string	The error message.
target	string	The error target.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

GetSensitivitySettingsResponse

Object

Data sensitivity settings for sensitive data discovery

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	GetSensitivitySettingsResponseProperties	The sensitivity settings properties
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

GetSensitivitySettingsResponseProperties

Object

The sensitivity settings properties

Name	Type	Description
mipInformation	GetSensitivitySettingsResponsePropertiesMipInformation	Microsoft information protection built-in and custom information types, labels, and integration status.
sensitiveInfoTypesIds	string[] (uuid)	List of selected sensitive info types' IDs.
sensitivityThresholdLabelId	string (uuid)	The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.
sensitivityThresholdLabelOrder	number (float)	The order of the sensitivity threshold label. Any label at or above this order will be considered sensitive. If set to -1, sensitivity by labels is turned off

GetSensitivitySettingsResponsePropertiesMipInformation

Object

Microsoft information protection built-in and custom information types, labels, and integration status.

Name	Type	Description
builtInInfoTypes	BuiltInInfoType[]	List of pre-configured sensitive information types
customInfoTypes	InfoType[]	List of custom user-defined information types
labels	Label[]	List of Microsoft information protection sensitivity labels
mipIntegrationStatus	MipIntegrationStatus	Microsoft information protection integration status

InfoType

Object

Custom user-defined information type

Name	Type	Description
description	string	Description of the info type
id	string (uuid)	Id of the info type
name	string	Display name of the info type

Label

Object

Microsoft information protection sensitivity label

Name	Type	Description
id	string (uuid)	The ID of the label
name	string	The display name of the label
order	number (float)	Labels are ordered by sensitivity level. The higher the order of the label, the more sensitive it is.

MipIntegrationStatus

Enumeration

Microsoft information protection integration status

Value	Description
Ok	Ok
noConsent	noConsent
noAutoLabelingRules	noAutoLabelingRules
noMipLabels	noMipLabels

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UpdateSensitivitySettingsRequest

Object

Request to update data sensitivity settings for sensitive data discovery

Name	Type	Description
sensitiveInfoTypesIds	string[] (uuid)	List of selected sensitive info types' IDs.
sensitivityThresholdLabelId	string (uuid)	The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.
sensitivityThresholdLabelOrder	number (float)	The order of the sensitivity threshold label. Any label at or above this order will be considered sensitive. If set to -1, sensitivity by labels is turned off