Sensitivity Settings - Create Or Update

Reference

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	API version for the operation

Request Body

Name	Required	Type	Description
sensitiveInfoTypesIds	True	string[]	List of selected sensitive info types' IDs.
sensitivityThresholdLabelId		string	The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.
sensitivityThresholdLabelOrder		number	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	Success of the sensitivity settings update
Other Status Codes	CloudError	Error response describing why the operation failed

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


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

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

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

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

Sample response

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

Definitions

Name	Description
BuiltInInfoType	Pre-configured sensitive information type
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.).
CloudErrorBody	The error detail.
ErrorAdditionalInfo	The resource management error additional info.
GetSensitivitySettingsResponse	Data sensitivity settings for sensitive data discovery
InfoType	Custom user-defined information type
Label	Microsoft information protection sensitivity label
MipInformation	Microsoft information protection built-in and custom information types, labels, and integration status.
MipIntegrationStatus	Microsoft information protection integration status
Properties	The sensitivity settings properties
UpdateSensitivitySettingsRequest	Request to update data sensitivity settings for sensitive data discovery

BuiltInInfoType

Pre-configured sensitive information type

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

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.).

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

CloudErrorBody

The error detail.

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

ErrorAdditionalInfo

The resource management error additional info.

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

GetSensitivitySettingsResponse

Data sensitivity settings for sensitive data discovery

Name	Type	Description
id	string	The ID of the sensitivity settings
name	string	The name of the sensitivity settings
properties	Properties	The sensitivity settings properties
type	string	The type of the sensitivity settings

InfoType

Custom user-defined information type

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

Label

Microsoft information protection sensitivity label

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

MipInformation

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

MipIntegrationStatus

Microsoft information protection integration status

Name	Type	Description
Ok	string
noAutoLabelingRules	string
noConsent	string
noMipLabels	string

Properties

The sensitivity settings properties

Name	Type	Description
mipInformation	MipInformation	Microsoft information protection built-in and custom information types, labels, and integration status.
sensitiveInfoTypesIds	string[]	List of selected sensitive info types' IDs.
sensitivityThresholdLabelId	string	The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.
sensitivityThresholdLabelOrder	number	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

UpdateSensitivitySettingsRequest

Request to update data sensitivity settings for sensitive data discovery

Name	Type	Description
sensitiveInfoTypesIds	string[]	List of selected sensitive info types' IDs.
sensitivityThresholdLabelId	string	The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive.
sensitivityThresholdLabelOrder	number	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

Share via

Sensitivity Settings - Create Or Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Update sensitivity settings

Sample request

Sample response

Definitions

BuiltInInfoType

CloudError

CloudErrorBody

ErrorAdditionalInfo

GetSensitivitySettingsResponse

InfoType

Label

MipInformation

MipIntegrationStatus

Properties

UpdateSensitivitySettingsRequest

Additional resources