Sensitivity Labels - Get

Serviço:: SQL Database

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

Obtém o rótulo de confidencialidade 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 de URI

Nome	Em	Obrigató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 na API do Azure Resource Manager ou no portal.
schemaName	path	True	string	O nome do esquema.
sensitivityLabelSource	path	True	SensitivityLabelSource	A origem do rótulo de confidencialidade.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID da 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

Nome	Tipo	Description
200 OK	SensitivityLabel	Recuperou com êxito o rótulo de confidencialidade.
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á em pausa. Retome-o. 400 SensitivityLabelSourceNameNotSupported - A origem do rótulo de confidencialidade especificada não é válida 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 SensitivityLabelsSchemaNotFound - Não foi possível encontrar o esquema {0} 404 SensitivityLabelsTableNotFound - A tabela {0} não pôde ser encontrada no esquema {1} 404 SensitivityLabelsColumnNotFound - Não foi possível encontrar a coluna {0} 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 - O rótulo de confidencialidade especificado não pôde ser encontrado 501 SensitivityLabelRecommendedSourceNameNotSupported - A origem do rótulo de confidencialidade 'recomendado' ainda não tem suporte 501 SensitivityLabelRecommendedSourceNameNotSupported - A origem do rótulo de confidencialidade 'recomendado' ainda não tem suporte

Nome

Tipo

Description

200 OK

SensitivityLabel

Recuperou com êxito o rótulo de confidencialidade.

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á em pausa. Retome-o.
400 SensitivityLabelSourceNameNotSupported - A origem do rótulo de confidencialidade especificada não é válida
404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado
404 SensitivityLabelsSchemaNotFound - Não foi possível encontrar o esquema {0}
404 SensitivityLabelsTableNotFound - A tabela {0} não pôde ser encontrada no esquema {1}
404 SensitivityLabelsColumnNotFound - Não foi possível encontrar a coluna {0} 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 - O rótulo de confidencialidade especificado não pôde ser encontrado
501 SensitivityLabelRecommendedSourceNameNotSupported - A origem do rótulo de confidencialidade 'recomendado' ainda não tem suporte
501 SensitivityLabelRecommendedSourceNameNotSupported - A origem do rótulo de confidencialidade 'recomendado' ainda não tem suporte

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 de exemplo

Código de status:: 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

Nome	Description
ClientClassificationSource
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SensitivityLabel	Um rótulo de confidencialidade.
SensitivityLabelRank
SensitivityLabelSource	A origem do rótulo de confidencialidade.

ClientClassificationSource

Enumeração

Valor	Description
None
Native
Recommended
MIP

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

SensitivityLabel

Objeto

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.clientClassificationSource	ClientClassificationSource
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.

SensitivityLabelRank

Enumeração

Valor	Description
None
Low
Medium
High
Critical

SensitivityLabelSource

Enumeração

A origem do rótulo de confidencialidade.

Valor	Description
current
recommended

Compartilhar via

Sensitivity Labels - Get

Parâmetros de URI

Respostas

Exemplos

Gets the sensitivity label of a given column

Solicitação de exemplo

Resposta de exemplo

Definições

ClientClassificationSource

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SensitivityLabel

SensitivityLabelRank

SensitivityLabelSource