Sensitivity Labels - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Creates or updates the sensitivity label of a given column

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/current?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
columnName	path	True	string	The name of the column.
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.
schemaName	path	True	string	The name of the schema.
sensitivityLabelSource	path	True	WritableSensitivityLabelSource	The source of the sensitivity label.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
tableName	path	True	string	The name of the table.
api-version	query	True	string	The API version to use for the request.

Request Body

Name	Type	Description
properties.informationType	string	The information type.
properties.informationTypeId	string	The information type ID.
properties.labelId	string	The label ID.
properties.labelName	string	The label name.
properties.rank	SensitivityLabelRank

Responses

Name	Type	Description
200 OK	SensitivityLabel	Successfully updated the sensitivity label.
201 Created	SensitivityLabel	Successfully created the sensitivity label.
Other Status Codes		*** Error Responses: *** 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 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 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

Examples

Updates the sensitivity label of a given column with all parameters

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current?api-version=2021-11-01

{
  "properties": {
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "Low"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SensitivityLabelInner;
import com.azure.resourcemanager.sql.models.SensitivityLabelRank;

/** Samples for SensitivityLabels CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ColumnSensitivityLabelCreateMax.json
     */
    /**
     * Sample code: Updates the sensitivity label of a given column with all parameters.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatesTheSensitivityLabelOfAGivenColumnWithAllParameters(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSensitivityLabels().createOrUpdateWithResponse("myRG",
            "myServer", "myDatabase", "dbo", "myTable", "myColumn",
            new SensitivityLabelInner().withLabelName("PII").withLabelId("bf91e08c-f4f0-478a-b016-25164b2a65ff")
                .withInformationType("PhoneNumber").withInformationTypeId("d22fa6e9-5ee4-3bde-4c2b-a409604c4646")
                .withRank(SensitivityLabelRank.LOW),
            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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
  "properties": {
    "schemaName": "dbo",
    "tableName": "myTable",
    "columnName": "myColumn",
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "Medium"
  }
}

Status code:

201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
  "properties": {
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "High"
  }
}

Definitions

Name	Description
SensitivityLabel	A sensitivity label.
SensitivityLabelRank
WritableSensitivityLabelSource	The source of the sensitivity label.

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

WritableSensitivityLabelSource

The source of the sensitivity label.

Name	Type	Description
current	string