Sensitivity Labels - Get

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=2017-03-01-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

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.

databaseName
path True
  • string

The name of the database.

schemaName
path True
  • string

The name of the schema.

tableName
path True
  • string

The name of the table.

columnName
path True
  • string

The name of the column.

sensitivityLabelSource
path True

The source of the sensitivity label.

api-version
query True
  • string

The API version to use for the request.

Responses

Name Type Description
200 OK

Successfully retrieved 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

  • 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found

  • 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

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

Examples

Gets the sensitivity label of a given column

Sample Request

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=2017-03-01-preview

Sample Response

{
  "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"
  }
}

Definitions

SensitivityLabel

A sensitivity label.

SensitivityLabelSource

The source of the sensitivity label.

SensitivityLabel

A sensitivity label.

Name Type Description
id
  • string

Resource ID.

name
  • string

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

type
  • string

Resource type.

SensitivityLabelSource

The source of the sensitivity label.

Name Type Description
current
  • string
recommended
  • string