Sensitivity Labels - Get

Service:

SQL Database

Version d'API:

2023-08-01

Obtient l’étiquette de confidentialité d’une colonne donnée

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
columnName	path	True	string	Nom de la colonne.
databaseName	path	True	string	Nom de la base de données.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
schemaName	path	True	string	Nom du schéma.
sensitivityLabelSource	path	True	SensitivityLabelSource	Source de l’étiquette de confidentialité.
serverName	path	True	string	Nom du serveur.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
tableName	path	True	string	Nom de la table.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Réponses

Nom	Type	Description
200 OK	SensitivityLabel	Récupération réussie de l’étiquette de confidentialité.
Other Status Codes	ErrorResponse	Réponses d’erreur : *** 400 DatawarehouseDatabaseIsDeactivated : impossible d’exécuter l’opération de classification des données, car la base de données est suspendue. Veuillez le reprendre. 400 SensitivityLabelSourceNameNotSupported : la source d’étiquette de confidentialité spécifiée n’est pas valide 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 SensitivityLabelsSchemaNotFound - Impossible de trouver le schéma {0} 404 SensitivityLabelsTableNotFound : la table {0} est introuvable dans le schéma {1} 404 SensitivityLabelsColumnNotFound : la colonne {0} est introuvable dans la table {2}.{1} 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur cette instance de serveur. 404 SensitivityLabelsLabelNotFound - Impossible de trouver l’étiquette de sensibilité spécifiée 501 SensitivityLabelRecommendedSourceNameNotSupported - La source d’étiquette de confidentialité « Recommandé » n’est pas encore prise en charge 501 SensitivityLabelRecommendedSourceNameNotSupported - La source d’étiquette de confidentialité « Recommandé » n’est pas encore prise en charge

Exemples

Gets the sensitivity label of a given column

Exemple de requête

HTTP

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

dotnet

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://learn.microsoft.com/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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ClientClassificationSource
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
SensitivityLabel	Étiquette de confidentialité.
SensitivityLabelRank
SensitivityLabelSource	Source de l’étiquette de confidentialité.

ClientClassificationSource

Énumération

Valeur	Description
None
Native
Recommended
MIP

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

SensitivityLabel

Object

Étiquette de confidentialité.

Nom	Type	Description
id	string	ID de ressource.
managedBy	string	Ressource qui gère l’étiquette de confidentialité.
name	string	Nom de la ressource.
properties.clientClassificationSource	ClientClassificationSource
properties.columnName	string	Nom de la colonne.
properties.informationType	string	Type d’informations.
properties.informationTypeId	string	ID de type d’informations.
properties.isDisabled	boolean	La recommandation de confidentialité est désactivée. Applicable uniquement pour l’étiquette de confidentialité recommandée. Spécifie si la recommandation de confidentialité sur cette colonne est désactivée (ignorée) ou non.
properties.labelId	string	ID d’étiquette.
properties.labelName	string	Nom de l’étiquette.
properties.rank	SensitivityLabelRank
properties.schemaName	string	Nom du schéma.
properties.tableName	string	Nom de la table.
type	string	Type de ressource.

SensitivityLabelRank

Énumération

Valeur	Description
None
Low
Medium
High
Critical

SensitivityLabelSource

Énumération

Source de l’étiquette de confidentialité.

Valeur	Description
current
recommended