Sensitivity Labels - Get

Serviço:: SQL Database

Versão da API:: 2023-08-01

Obtém o rótulo de sensibilidade de uma determinada coluna

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
columnName	path	True	string	O nome da coluna.
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 da API do Azure Resource Manager ou do portal.
schemaName	path	True	string	O nome do esquema.
sensitivityLabelSource	path	True	SensitivityLabelSource	A fonte do rótulo de sensibilidade.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
tableName	path	True	string	O nome da tabela.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Respostas

Name	Tipo	Description
200 OK	SensitivityLabel	Recuperado com êxito o rótulo de sensibilidade.
Other Status Codes	ErrorResponse	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á pausado. Por favor, retome-o. 400 SensitivityLabelSourceNameNotSupported - A origem do rótulo de sensibilidade especificado não é válida 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 SensitivityLabelsSchemaNotFound - Não foi possível encontrar o {0} do esquema 404 SensitivityLabelsTableNotFound - A tabela {0} não pôde ser encontrada no esquema {1} 404 SensitivityLabelsColumnNotFound - A coluna {0} não pôde ser encontrada na tabela {2}.{1} 404 DatabaseDoesNotExist - O usuário especificou um nome de banco de dados que não existe nesta instância do servidor. 404 SensitivityLabelsLabelNotFound - Não foi possível encontrar o rótulo de sensibilidade especificado 501 SensitivityLabelRecommendedSourceNameNotSupported - A fonte do rótulo de sensibilidade 'Recomendado' ainda não é suportada 501 SensitivityLabelRecommendedSourceNameNotSupported - A fonte do rótulo de sensibilidade 'Recomendado' ainda não é suportada

Name

Tipo

Description

200 OK

SensitivityLabel

Recuperado com êxito o rótulo de sensibilidade.

Other Status Codes

ErrorResponse

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á pausado. Por favor, retome-o.
400 SensitivityLabelSourceNameNotSupported - A origem do rótulo de sensibilidade especificado não é válida
404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado
404 SensitivityLabelsSchemaNotFound - Não foi possível encontrar o {0} do esquema
404 SensitivityLabelsTableNotFound - A tabela {0} não pôde ser encontrada no esquema {1}
404 SensitivityLabelsColumnNotFound - A coluna {0} não pôde ser encontrada na tabela {2}.{1}
404 DatabaseDoesNotExist - O usuário especificou um nome de banco de dados que não existe nesta instância do servidor.
404 SensitivityLabelsLabelNotFound - Não foi possível encontrar o rótulo de sensibilidade especificado
501 SensitivityLabelRecommendedSourceNameNotSupported - A fonte do rótulo de sensibilidade 'Recomendado' ainda não é suportada
501 SensitivityLabelRecommendedSourceNameNotSupported - A fonte do rótulo de sensibilidade 'Recomendado' ainda não é suportada

Exemplos

Gets the sensitivity label of a given column

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ColumnSensitivityLabelGet.json
// this example is just showing the usage of "SensitivityLabels_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://v4.hkg1.meaqua.org/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseSensitivityLabelResource created on azure
// for more information of creating SqlDatabaseSensitivityLabelResource, please refer to the document of SqlDatabaseSensitivityLabelResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string serverName = "myServer";
string databaseName = "myDatabase";
string schemaName = "dbo";
string tableName = "myTable";
string columnName = "myColumn";
SensitivityLabelSource sensitivityLabelSource = SensitivityLabelSource.Current;
ResourceIdentifier sqlDatabaseSensitivityLabelResourceId = SqlDatabaseSensitivityLabelResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, schemaName, tableName, columnName, sensitivityLabelSource);
SqlDatabaseSensitivityLabelResource sqlDatabaseSensitivityLabel = client.GetSqlDatabaseSensitivityLabelResource(sqlDatabaseSensitivityLabelResourceId);

// invoke the operation
SqlDatabaseSensitivityLabelResource result = await sqlDatabaseSensitivityLabel.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SensitivityLabelData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 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"
  }
}

Definições

Name	Description
ClientClassificationSource
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SensitivityLabel	Um rótulo de sensibilidade.
SensitivityLabelRank
SensitivityLabelSource	A fonte do rótulo de sensibilidade.

ClientClassificationSource

Enumeração

Valor	Description
None
Native
Recommended
MIP

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

SensitivityLabel

Object

Um rótulo de sensibilidade.

Name	Tipo	Description
id	string	ID do recurso.
managedBy	string	Recurso que gerencia o rótulo de sensibilidade.
name	string	Nome do recurso.
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	O nome da coluna.
properties.informationType	string	O tipo de informação.
properties.informationTypeId	string	O ID do tipo de informação.
properties.isDisabled	boolean	A recomendação de sensibilidade está desativada. Aplicável apenas para o rótulo de sensibilidade recomendado. Especifica se a recomendação de sensibilidade nesta coluna está desabilitada (descartada) ou não.
properties.labelId	string	O 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.

SensitivityLabelRank

Enumeração

Valor	Description
None
Low
Medium
High
Critical

SensitivityLabelSource

Enumeração

A fonte do rótulo de sensibilidade.

Valor	Description
current
recommended

Partilhar via

Sensitivity Labels - Get

Parâmetros do URI

Respostas

Exemplos

Gets the sensitivity label of a given column

Pedido de amostra

Resposta da amostra

Definições

ClientClassificationSource

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SensitivityLabel

SensitivityLabelRank

SensitivityLabelSource