Sensitivity Labels - Get

Service:

SQL Database

API Version:

2023-08-01

Gets the sensitivity label of a given column

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}?api-version=2023-08-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	SensitivityLabelSource	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.

Responses

Name	Type	Description
200 OK	SensitivityLabel	Successfully retrieved the sensitivity label.
Other Status Codes	ErrorResponse	*** 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 404 SubscriptionDoesNotHaveServer - The requested server was not 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} 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 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet

Examples

Gets the sensitivity label of a given column

Sample request

HTTP

GET 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=2023-08-01

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": "High"
  }
}

Definitions

Name	Description
ClientClassificationSource
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SensitivityLabel	A sensitivity label.
SensitivityLabelRank
SensitivityLabelSource	The source of the sensitivity label.

ClientClassificationSource

Enumeration

Value	Description
MIP
Native
None
Recommended

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

The error detail.

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

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

SensitivityLabel

Object

A sensitivity label.

Name	Type	Description
id	string	Resource ID.
managedBy	string	Resource that manages the sensitivity label.
name	string	Resource name.
properties.clientClassificationSource	ClientClassificationSource
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

Enumeration

Value	Description
Critical
High
Low
Medium
None

SensitivityLabelSource

Enumeration

The source of the sensitivity label.

Value	Description
current
recommended