Sensitivity Labels - List Current By Database

Service:

SQL Database

Version d'API:

2023-08-01

Obtient les étiquettes de confidentialité d’une base de données donnée

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

Avec des paramètres facultatifs:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels?$skipToken={$skipToken}&$count={$count}&$filter={$filter}&api-version=2023-08-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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.
serverName	path	True	string	Nom du serveur.
subscriptionId	path	True	string	ID d’abonnement qui identifie un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
$count	query		boolean
$filter	query		string	Expression de filtre OData qui filtre les éléments de la collection.
$skipToken	query		string

Réponses

Nom	Type	Description
200 OK	SensitivityLabelListResult	Récupère correctement les étiquettes 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 SensitivityLabelsInvalidODataQuery : la requête OData spécifiée n’est pas valide ou n’est pas prise en charge 404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur cette instance de serveur. 503 DatabaseUnavailable : l’opération a échoué, car la base de données n’est pas disponible.

Exemples

Gets the current sensitivity labels of a given database

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/currentSensitivityLabels?api-version=2023-08-01

dotnet

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json
// this example is just showing the usage of "SensitivityLabels_ListCurrentByDatabase" 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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "myRG";
string serverName = "myServer";
string databaseName = "myDatabase";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation and iterate over the result
await foreach (SqlDatabaseSensitivityLabelResource item in sqlDatabase.GetCurrentSensitivityLabelsAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn3/sensitivityLabels/current",
      "name": "current",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
      "properties": {
        "schemaName": "dbo",
        "tableName": "myTable",
        "columnName": "myColumn3",
        "informationType": "Financial",
        "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
        "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a",
        "labelName": "Sensitive",
        "rank": "Low"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn4/sensitivityLabels/current",
      "name": "current",
      "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels",
      "properties": {
        "schemaName": "dbo",
        "tableName": "myTable",
        "columnName": "myColumn4",
        "informationType": "Email",
        "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
        "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
        "labelName": "PII",
        "rank": "None"
      }
    }
  ]
}

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é.
SensitivityLabelListResult	Liste des étiquettes de confidentialité.
SensitivityLabelRank

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.

SensitivityLabelListResult

Object

Liste des étiquettes de confidentialité.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page suivante des résultats.
value	SensitivityLabel[]	Tableau de résultats.

SensitivityLabelRank

Énumération

Valeur	Description
None
Low
Medium
High
Critical