Managed Database Sensitivity Labels - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Crée ou met à jour l’étiquette de confidentialité d’une colonne donnée

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/current?api-version=2021-11-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.
managedInstanceName	path	True	string	Nom de l'instance managée.
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	WritableSensitivityLabelSource	Source de l’étiquette de confidentialité.
subscriptionId	path	True	string	L’ID d’abonnement d’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.

Corps de la demande

Nom	Type	Description
properties.informationType	string	Type d’informations.
properties.informationTypeId	string	ID du type d’informations.
properties.labelId	string	ID de l’étiquette.
properties.labelName	string	Nom de l'étiquette.
properties.rank	SensitivityLabelRank

Réponses

Nom	Type	Description
200 OK	SensitivityLabel	Mise à jour réussie de l’étiquette de confidentialité.
201 Created	SensitivityLabel	L’étiquette de confidentialité a été créée.
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 SensitivityLabelSourceNameNotSupported : la source de l’étiquette de confidentialité spécifiée n’est pas valide 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 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

Exemples

Updates or creates a sensitivity label of a given column with all parameters in a managed database

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current?api-version=2021-11-01

{
  "properties": {
    "informationType": "PhoneNumber",
    "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
    "labelId": "bf91e08c-f4f0-478a-b016-25164b2a65ff",
    "labelName": "PII",
    "rank": "High"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.SensitivityLabelInner;
import com.azure.resourcemanager.sql.models.SensitivityLabelRank;

/** Samples for ManagedDatabaseSensitivityLabels CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedDatabaseColumnSensitivityLabelCreate.json
     */
    /**
     * Sample code: Updates or creates a sensitivity label of a given column with all parameters in a managed database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatesOrCreatesASensitivityLabelOfAGivenColumnWithAllParametersInAManagedDatabase(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseSensitivityLabels().createOrUpdateWithResponse(
            "myRG", "myManagedInstanceName", "myDatabase", "dbo", "myTable", "myColumn",
            new SensitivityLabelInner().withLabelName("PII").withLabelId("bf91e08c-f4f0-478a-b016-25164b2a65ff")
                .withInformationType("PhoneNumber").withInformationTypeId("d22fa6e9-5ee4-3bde-4c2b-a409604c4646")
                .withRank(SensitivityLabelRank.HIGH),
            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

Sample Response

Status code:

200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/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"
  }
}

Status code:

201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/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
SensitivityLabel	Étiquette de confidentialité.
SensitivityLabelRank
WritableSensitivityLabelSource	Source de l’étiquette 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

WritableSensitivityLabelSource

Source de l’étiquette de confidentialité.

Nom	Type	Description
current	string