Sensitivity Labels - List Recommended By Database

Serviço:

SQL Database

Versão da API:

2021-11-01

Obtém os rótulos de confidencialidade de um determinado banco de dados

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels?api-version=2021-11-01

Com parâmetros opcionais:

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 URI

Nome	Em	Obrigatório	Tipo	Description
databaseName	path	True	string	O nome do banco de dados.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
$filter	query		string	Uma expressão de filtro OData que filtra elementos na coleção.
$skipToken	query		string
includeDisabledRecommendations	query		boolean	Especifica se as recomendações desabilitadas devem ser incluídas ou não.

Respostas

Nome	Tipo	Description
200 OK	SensitivityLabelListResult	Os rótulos de confidencialidade foram recuperados com êxito.
Other Status Codes		Respostas de erro: *** 400 DatawarehouseDatabaseIsDeactivated - Não foi possível executar a operação de Classificação de Dados porque o banco de dados está em pausa. Por favor, retome-o. 400 SensitivityLabelsInvalidODataQuery - A consulta OData especificada não é válida ou não tem suporte 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 DatabaseDoesNotExist - O usuário especificou um nome de banco de dados que não existe nesta instância de servidor. 503 DatabaseUnavailable - A operação falhou porque o banco de dados não está disponível.

Exemplos

Gets the recommended sensitivity labels of a given database

Solicitação de exemplo

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for SensitivityLabels ListRecommendedByDatabase. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * SensitivityLabelsListByDatabaseWithSourceRecommended.json
     */
    /**
     * Sample code: Gets the recommended sensitivity labels of a given database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getsTheRecommendedSensitivityLabelsOfAGivenDatabase(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSensitivityLabels().listRecommendedByDatabase("myRG",
            "myServer", "myDatabase", null, null, null, 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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
SensitivityLabel	Um rótulo de confidencialidade.
SensitivityLabelListResult	Uma lista de rótulos de confidencialidade.
SensitivityLabelRank

SensitivityLabel

Um rótulo de confidencialidade.

Nome	Tipo	Description
id	string	ID do recurso.
managedBy	string	Recurso que gerencia o rótulo de confidencialidade.
name	string	Nome do recurso.
properties.columnName	string	O nome da coluna.
properties.informationType	string	O tipo de informação.
properties.informationTypeId	string	A ID do tipo de informação.
properties.isDisabled	boolean	A recomendação de confidencialidade está desabilitada. Aplicável somente ao rótulo de confidencialidade recomendado. Especifica se a recomendação de confidencialidade nesta coluna está desabilitada (ignorada) ou não.
properties.labelId	string	A ID do rótulo.
properties.labelName	string	O nome do rótulo.
properties.rank	SensitivityLabelRank
properties.schemaName	string	O nome do esquema.
properties.tableName	string	O nome da tabela.
type	string	Tipo de recurso.

SensitivityLabelListResult

Uma lista de rótulos de confidencialidade.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	SensitivityLabel[]	Matriz de resultados.

SensitivityLabelRank

Nome	Tipo	Description
Critical	string
High	string
Low	string
Medium	string
None	string