Sensitivity Labels - List Recommended By Database

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

Obtiene las etiquetas de confidencialidad de una base de datos determinada.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
databaseName
 path True

string

El nombre de la base de datos.
resourceGroupName
 path True

string

Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName
 path True

string

El nombre del servidor.
subscriptionId
 path True

string

El id. de suscripción que identifica una suscripción de Azure.
api-version
 query True

string

La versión de API que se usará para la solicitud.
$filter
 query

string

Expresión de filtro de OData que filtra los elementos de la colección.
$skipToken
 query

string

includeDisabledRecommendations
 query

boolean

Especifica si se deben incluir o no recomendaciones deshabilitadas.

Respuestas

Nombre Tipo Description
200 OK

SensitivityLabelListResult

Recuperó correctamente las etiquetas de confidencialidad.
Other Status Codes

Respuestas de error: ***

  • 400 DatawarehouseDatabaseIsDeactivated: no se pudo ejecutar la operación de clasificación de datos porque la base de datos está en pausa. Por favor reanudarlo.

  • 400 SensitivityLabelsInvalidODataQuery: la consulta OData especificada no es válida o no es compatible.

  • 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.

  • 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor.

  • 503 DatabaseUnavailable: error en la operación porque la base de datos no está disponible.

Ejemplos

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

Definiciones

Nombre Description
SensitivityLabel

Etiqueta de confidencialidad.
SensitivityLabelListResult

Lista de etiquetas de confidencialidad.
SensitivityLabelRank

SensitivityLabel

Etiqueta de confidencialidad.

Nombre Tipo Description
id

string

Identificador del recurso.
managedBy

string

Recurso que administra la etiqueta de confidencialidad.
name

string

Nombre del recurso.
properties.columnName

string

Nombre de columna.
properties.informationType

string

Tipo de información.
properties.informationTypeId

string

Identificador de tipo de información.
properties.isDisabled

boolean

Está deshabilitada la recomendación de confidencialidad. Aplicable solo a la etiqueta de confidencialidad recomendada. Especifica si la recomendación de confidencialidad de esta columna está deshabilitada (descartada) o no.
properties.labelId

string

Identificador de la etiqueta.
properties.labelName

string

Nombre de la etiqueta.
properties.rank

SensitivityLabelRank

properties.schemaName

string

El nombre del esquema.
properties.tableName

string

El nombre de la tabla.
type

string

Tipo de recurso.

SensitivityLabelListResult

Lista de etiquetas de confidencialidad.

Nombre Tipo Description
nextLink

string

Vínculo para recuperar la página siguiente de resultados.
value

SensitivityLabel[]

Matriz de resultados.

SensitivityLabelRank

Nombre Tipo Description
Critical

string

High

string

Low

string

Medium

string

None

string