Sensitivity Labels - Update

Update sensitivity labels of a given database using an operations batch.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels?api-version=2021-11-01

URI Parameters

Name In Required Type Description
databaseName
path True

string

The name of the database.

resourceGroupName
path True

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName
path True

string

The name of the server.

subscriptionId
path True

string

The subscription ID that identifies an Azure subscription.

api-version
query True

string

The API version to use for the request.

Request Body

Name Type Description
operations

SensitivityLabelUpdate[]

A sensitivity label update operation.

Responses

Name Type Description
200 OK

Successfully updated sensitivity labels.

Other Status Codes

*** Error Responses: ***

  • 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.

  • 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.

  • 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid

  • 400 InvalidSensitivityLabelsBatch - The specified sensitivity labels batch is not valid. Please provide batch operations

  • 400 SensitivityLabelsMissingSchema - Operation[{0}]: Missing schema information

  • 400 SensitivityLabelsMissingTable - Operation[{0}]: Missing table information

  • 400 SensitivityLabelsMissingColumn - Operation[{0}]: Missing column information

  • 400 SensitivityLabelsUpdateSameColumnMoreThanOnce - The column {0} can not be updated more than once in a single command

  • 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid

  • 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified

  • 400 LabelNameTooLong - Label name cannot exceed {0} characters

  • 400 InformationTypeTooLong - Information type cannot exceed {0} characters

  • 400 LabelIdMustBeGuid - The provided ‘labelId’ is invalid. Value must be a GUID

  • 400 InformationTypeIdMustBeGuid - The provided ‘informationTypeId’ is invalid. Value must be a GUID

  • 400 LabelMissing - Label is required. At least one of ‘labelName’ or ‘labelId’ must be provided

  • 400 InformationTypeMissing - Information type is required. At least one of ‘informationType’ or ‘informationTypeId’ must be provided

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.

  • 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found

  • 404 SensitivityLabelsSchemaNotFound - The schema {0} could not be found

  • 404 SensitivityLabelsTableNotFound - The table {0} could not be found in schema {1}

  • 404 SensitivityLabelsColumnNotFound - The column {0} could not be found in table {2}.{1}

  • 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet

  • 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet

  • 503 DatabaseUnavailable - The operation failed because the database is unavailable.

Examples

Update sensitivity labels of a given database using an operations batch.

Sample request

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/currentSensitivityLabels?api-version=2021-11-01

{
  "operations": [
    {
      "properties": {
        "op": "set",
        "schema": "dbo",
        "table": "table1",
        "column": "column1",
        "sensitivityLabel": {
          "properties": {
            "labelName": "Highly Confidential",
            "labelId": "3A477B16-9423-432B-AA97-6069B481CEC3",
            "informationType": "Financial",
            "informationTypeId": "1D3652D6-422C-4115-82F1-65DAEBC665C8",
            "rank": "Low"
          }
        }
      }
    },
    {
      "properties": {
        "op": "set",
        "schema": "dbo",
        "table": "table2",
        "column": "column2",
        "sensitivityLabel": {
          "properties": {
            "informationType": "PhoneNumber",
            "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
            "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
            "labelName": "PII",
            "rank": "Critical"
          }
        }
      }
    },
    {
      "properties": {
        "op": "remove",
        "schema": "dbo",
        "table": "Table1",
        "column": "Column3"
      }
    }
  ]
}

Sample response

Definitions

Name Description
SensitivityLabel

A sensitivity label.

SensitivityLabelRank
SensitivityLabelUpdate

A sensitivity label update operation.

SensitivityLabelUpdateKind
SensitivityLabelUpdateList

A list of sensitivity label update operations.

SensitivityLabel

A sensitivity label.

Name Type Description
id

string

Resource ID.

managedBy

string

Resource that manages the sensitivity label.

name

string

Resource name.

properties.columnName

string

The column name.

properties.informationType

string

The information type.

properties.informationTypeId

string

The information type ID.

properties.isDisabled

boolean

Is sensitivity recommendation disabled. Applicable for recommended sensitivity label only. Specifies whether the sensitivity recommendation on this column is disabled (dismissed) or not.

properties.labelId

string

The label ID.

properties.labelName

string

The label name.

properties.rank

SensitivityLabelRank

properties.schemaName

string

The schema name.

properties.tableName

string

The table name.

type

string

Resource type.

SensitivityLabelRank

Name Type Description
Critical

string

High

string

Low

string

Medium

string

None

string

SensitivityLabelUpdate

A sensitivity label update operation.

Name Type Description
id

string

Resource ID.

name

string

Resource name.

properties.column

string

Column name to update.

properties.op

SensitivityLabelUpdateKind

properties.schema

string

Schema name of the column to update.

properties.sensitivityLabel

SensitivityLabel

The sensitivity label information to apply on a column.

properties.table

string

Table name of the column to update.

type

string

Resource type.

SensitivityLabelUpdateKind

Name Type Description
remove

string

set

string

SensitivityLabelUpdateList

A list of sensitivity label update operations.

Name Type Description
operations

SensitivityLabelUpdate[]

A sensitivity label update operation.