Managed Database Sensitivity Labels - List Recommended By Database

Service:

SQL Database

API Version:

2021-11-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/managedInstances/{managedInstanceName}/databases/{databaseName}/recommendedSensitivityLabels?api-version=2021-11-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/recommendedSensitivityLabels?$skipToken={$skipToken}&includeDisabledRecommendations={includeDisabledRecommendations}&$filter={$filter}&api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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.
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.
$filter	query		string	Expression de filtre OData qui filtre les éléments de la collection.
$skipToken	query		string
includeDisabledRecommendations	query		boolean	Spécifie s’il faut inclure ou non des recommandations désactivées.

Réponses

Nom	Type	Description
200 OK	SensitivityLabelListResult	Récupération réussie des étiquettes de confidentialité.
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 le reprendre. 400 SensitivityLabelsInvalidODataQuery : la requête OData spécifiée n’est pas valide ou non 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 ce serveur instance. 503 DatabaseUnavailable : l’opération a échoué, car la base de données n’est pas disponible.

Exemples

Gets the recommended sensitivity labels of a given database in a managed database

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/recommendedSensitivityLabels?api-version=2021-11-01

Java

import com.azure.core.util.Context;

/** Samples for ManagedDatabaseSensitivityLabels ListRecommendedByDatabase. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ManagedDatabaseSensitivityLabelsListByDatabaseRecommended.json
     */
    /**
     * Sample code: Gets the recommended sensitivity labels of a given database in a managed database.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsTheRecommendedSensitivityLabelsOfAGivenDatabaseInAManagedDatabase(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseSensitivityLabels()
            .listRecommendedByDatabase("myRG", "myManagedInstanceName", "myDatabase", null, null, null, 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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended",
      "name": "recommended",
      "type": "Microsoft.Sql/managedInstances/databases/schemas/tables/columns/sensitivityLabels",
      "properties": {
        "schemaName": "dbo",
        "tableName": "myTable",
        "columnName": "myColumn2",
        "informationType": "Financial",
        "informationTypeId": "d22fa6e9-5ee4-3bde-4c2b-a409604c4646",
        "labelId": "05e6eaa1-075a-4fb4-a732-a92215a2444a",
        "labelName": "Sensitive"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/managedInstances/myManagedInstanceName/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn4/sensitivityLabels/recommended",
      "name": "recommended",
      "type": "Microsoft.Sql/managedInstances/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"
      }
    }
  ]
}

Définitions

Nom	Description
SensitivityLabel	Étiquette de confidentialité.
SensitivityLabelListResult	Liste d’étiquettes de confidentialité.
SensitivityLabelRank

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 de type d’informations.
properties.isDisabled	boolean	La recommandation de confidentialité 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.

SensitivityLabelListResult

Liste d’étiquettes de confidentialité.

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

SensitivityLabelRank

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