Sensitivity Labels - Update

Service:

SQL Database

Version d'API:

2021-11-01

Mettre à jour les étiquettes de confidentialité d’une base de données donnée à l’aide d’un lot d’opérations.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels?api-version=2021-11-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	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Type	Description
operations	SensitivityLabelUpdate[]	Opération de mise à jour des étiquettes de confidentialité.

Réponses

Nom	Type	Description
200 OK		Étiquettes de confidentialité correctement mises à jour.
Other Status Codes		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 la reprendre. 400 DatawarehouseDatabaseIsDeactivated : impossible d’exécuter l’opération de classification des données, car la base de données est suspendue. Veuillez la reprendre. 400 SensitivityLabelSourceNameNotSupported : la source de l’étiquette de confidentialité spécifiée n’est pas valide 400 InvalidSensitivityLabelsBatch : le lot d’étiquettes de confidentialité spécifié n’est pas valide. Veuillez fournir des opérations de traitement par lots 400 SensitivityLabelsMissingSchema - Operation[{0}] : informations de schéma manquantes 400 SensitivityLabelsMissingTable - Operation[{0}] : informations de table manquantes 400 SensitivityLabelsMissingColumn - Operation[{0}] : informations de colonne manquantes 400 SensitivityLabelsUpdateSameColumnMoreThanOnce : la colonne {0} ne peut pas être mise à jour plusieurs fois dans une seule commande 400 InvalidSensitivityLabelResource : la ressource d’étiquette de confidentialité spécifiée n’est pas valide 400 SensitivityLabelNameAndInfoTypeNotProvided : au moins l’un des types LabelName et InformationType doit être spécifié 400 LabelNameTooLong : le nom de l’étiquette ne peut pas dépasser les {0} caractères 400 InformationTypeTooLong : le type d’informations ne peut pas dépasser les {0} caractères 400 LabelIdMustBeGuid : le 'labelId' fourni n’est pas valide. La valeur doit être un GUID 400 InformationTypeIdMustBeGuid : l’élément « informationTypeId » fourni n’est pas valide. La valeur doit être un GUID 400 LabelMissing : l’étiquette est requise. Au moins un des éléments 'labelName' ou 'labelId' doit être fourni 400 InformationTypeMissing : type d’informations requis. Au moins un des éléments « informationType » ou « informationTypeId » doit être fourni 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 ce serveur instance. 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 ce serveur instance. 404 SensitivityLabelsLabelNotFound : l’étiquette de confidentialité spécifiée est introuvable 404 SensitivityLabelsSchemaNotFound : le schéma {0} est introuvable 404 SensitivityLabelsTableNotFound : la table {0} est introuvable dans le schéma {1} 404 SensitivityLabelsColumnNotFound : la colonne {0} est introuvable dans la table {2}.{1} 501 SensitivityLabelRecommendedSourceNameNotSupported : la source de l’étiquette de confidentialité « Recommandé » n’est pas encore prise en charge 501 SensitivityLabelRecommendedSourceNameNotSupported : la source de l’étiquette de confidentialité « Recommandé » n’est pas encore prise en charge 503 DatabaseUnavailable : l’opération a échoué car la base de données n’est pas disponible.

Exemples

Update sensitivity labels of a given database using an operations batch.

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/currentSensitivityLabels?api-version=2021-11-01

{
  "operations": [
    {
      "properties": {
        "op": "set",
        "schema": "dbo",
        "table": "table1",
        "column": "column1",
        "sensitivityLabel": {
          "properties": {
            "labelName": "Highly Confidential",
            "labelId": "3A477B16-9423-432B-AA97-6069B481CEC3",
            "informationType": "Financial",
            "informationTypeId": "1D3652D6-422C-4115-82F1-65DAEBC665C8",
            "rank": "Low"
          }
        }
      }
    },
    {
      "properties": {
        "op": "set",
        "schema": "dbo",
        "table": "table2",
        "column": "column2",
        "sensitivityLabel": {
          "properties": {
            "informationType": "PhoneNumber",
            "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
            "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
            "labelName": "PII",
            "rank": "Critical"
          }
        }
      }
    },
    {
      "properties": {
        "op": "remove",
        "schema": "dbo",
        "table": "Table1",
        "column": "Column3"
      }
    }
  ]
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SensitivityLabelInner;
import com.azure.resourcemanager.sql.fluent.models.SensitivityLabelUpdateInner;
import com.azure.resourcemanager.sql.models.SensitivityLabelRank;
import com.azure.resourcemanager.sql.models.SensitivityLabelUpdateKind;
import com.azure.resourcemanager.sql.models.SensitivityLabelUpdateList;
import java.util.Arrays;

/** Samples for SensitivityLabels Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/SensitivityLabelsCurrentUpdate.json
     */
    /**
     * Sample code: Update sensitivity labels of a given database using an operations batch.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateSensitivityLabelsOfAGivenDatabaseUsingAnOperationsBatch(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getSensitivityLabels().updateWithResponse("myRG", "myServer",
            "myDatabase",
            new SensitivityLabelUpdateList().withOperations(Arrays.asList(new SensitivityLabelUpdateInner()
                .withOp(SensitivityLabelUpdateKind.SET).withSchema("dbo").withTable("table1").withColumn("column1")
                .withSensitivityLabel(new SensitivityLabelInner().withLabelName("Highly Confidential")
                    .withLabelId("3A477B16-9423-432B-AA97-6069B481CEC3").withInformationType("Financial")
                    .withInformationTypeId("1D3652D6-422C-4115-82F1-65DAEBC665C8").withRank(SensitivityLabelRank.LOW)),
                new SensitivityLabelUpdateInner().withOp(SensitivityLabelUpdateKind.SET).withSchema("dbo")
                    .withTable("table2").withColumn("column2")
                    .withSensitivityLabel(new SensitivityLabelInner().withLabelName("PII")
                        .withLabelId("bf91e08c-f4f0-478a-b016-25164b2a65ff").withInformationType("PhoneNumber")
                        .withInformationTypeId("d22fa6e9-5ee4-3bde-4c2b-a409604c4646")
                        .withRank(SensitivityLabelRank.CRITICAL)),
                new SensitivityLabelUpdateInner().withOp(SensitivityLabelUpdateKind.REMOVE).withSchema("dbo")
                    .withTable("Table1").withColumn("Column3"))),
            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

Exemple de réponse

Code d’état:

200

Définitions

Nom	Description
SensitivityLabel	Étiquette de confidentialité.
SensitivityLabelRank
SensitivityLabelUpdate	Opération de mise à jour des étiquettes de confidentialité.
SensitivityLabelUpdateKind
SensitivityLabelUpdateList	Liste des opérations de mise à jour des étiquettes de confidentialité.

SensitivityLabel

Étiquette de confidentialité.

Nom	Type	Description
id	string	ID de la ressource
managedBy	string	Ressource qui gère l’étiquette de confidentialité.
name	string	Nom de la ressource.
properties.columnName	string	Nom de la colonne.
properties.informationType	string	Type d’informations.
properties.informationTypeId	string	ID du type d’informations.
properties.isDisabled	boolean	La recommandation de sensibilité est-elle 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 de l’étiquette.
properties.labelName	string	Nom de l'étiquette.
properties.rank	SensitivityLabelRank
properties.schemaName	string	Nom de schéma.
properties.tableName	string	Nom de la table.
type	string	Type de ressource.

SensitivityLabelRank

Nom	Type	Description
Critical	string
High	string
Low	string
Medium	string
None	string

SensitivityLabelUpdate

Opération de mise à jour des étiquettes de confidentialité.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.column	string	Nom de colonne à mettre à jour.
properties.op	SensitivityLabelUpdateKind
properties.schema	string	Nom de schéma de la colonne à mettre à jour.
properties.sensitivityLabel	SensitivityLabel	Informations d’étiquette de confidentialité à appliquer à une colonne.
properties.table	string	Nom de la table de la colonne à mettre à jour.
type	string	Type de ressource.

SensitivityLabelUpdateKind

Nom	Type	Description
remove	string
set	string

SensitivityLabelUpdateList

Liste des opérations de mise à jour des étiquettes de confidentialité.

Nom	Type	Description
operations	SensitivityLabelUpdate[]	Opération de mise à jour des étiquettes de confidentialité.