Share via

Sensitivity Labels - List Recommended By Database

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets the sensitivity labels of a given database

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels?api-version=2021-11-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels?$skipToken={$skipToken}&includeDisabledRecommendations={includeDisabledRecommendations}&$filter={$filter}&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.
$filter
 query

string

An OData filter expression that filters elements in the collection.
$skipToken
 query

string

includeDisabledRecommendations
 query

boolean

Specifies whether to include disabled recommendations or not.

Responses

Name Type Description
200 OK

SensitivityLabelListResult

Successfully retrieved the sensitivity labels.
Other Status Codes

*** Error Responses: ***

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

  • 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

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

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

Examples

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/recommended",
      "name": "recommended",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
      "properties": {
        "schemaName": "dbo",
        "tableName": "myTable",
        "columnName": "myColumn",
        "informationType": "Financial",
        "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
        "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a",
        "labelName": "Sensitive"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended",
      "name": "recommended",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
      "properties": {
        "schemaName": "dbo",
        "tableName": "myTable",
        "columnName": "myColumn2",
        "informationType": "Email",
        "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
        "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
        "labelName": "PII"
      }
    }
  ]
}

Definitions

Name Description
SensitivityLabel

A sensitivity label.
SensitivityLabelListResult

A list of sensitivity labels.
SensitivityLabelRank

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.

SensitivityLabelListResult

A list of sensitivity labels.

Name Type Description
nextLink

string

Link to retrieve next page of results.
value

SensitivityLabel[]

Array of results.

SensitivityLabelRank

Name Type Description
Critical

string

High

string

Low

string

Medium

string

None

string