Data Masking Rules - List By Database

Référence

Service:: SQL Database

API Version:: 2021-11-01

Obtient une liste des règles de masquage des données de base de données.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default/rules?api-version=2021-11-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Nom de la base de données à laquelle la règle de masquage des données s’applique.
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.

Réponses

Nom	Type	Description
200 OK	DataMaskingRuleListResult	Récupération réussie de la liste des états de protection avancée contre les menaces du serveur.
Other Status Codes		Réponses d’erreur : ***

Exemples

Gets a list of database data masking rules.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules?api-version=2021-11-01


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;

/** Samples for DataMaskingRules ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DataMaskingRuleListByDatabase.json
     */
    /**
     * Sample code: Gets a list of database data masking rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabaseDataMaskingRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDataMaskingRules().listByDatabase("sqlcrudtest-6852",
            "sqlcrudtest-2080", "sqlcrudtest-331", DataMaskingPolicyName.DEFAULT, 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/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/",
      "name": null,
      "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
      "location": "Central US",
      "kind": null,
      "properties": {
        "id": "dbo_Table_1_test1",
        "ruleState": "Enabled",
        "schemaName": "dbo",
        "tableName": "Table_1",
        "columnName": "test1",
        "aliasName": null,
        "maskingFunction": "Text",
        "numberFrom": null,
        "numberTo": null,
        "prefixSize": "1",
        "suffixSize": "0",
        "replacementString": "asdf"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/",
      "name": null,
      "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
      "location": "Central US",
      "kind": null,
      "properties": {
        "id": "dbo_Table_1_test1",
        "ruleState": "Enabled",
        "schemaName": "dbo",
        "tableName": "Table_1",
        "columnName": "test1",
        "aliasName": null,
        "maskingFunction": "Number",
        "numberFrom": "0",
        "numberTo": "2",
        "prefixSize": null,
        "suffixSize": null,
        "replacementString": null
      }
    }
  ]
}

Définitions

Nom	Description
DataMaskingFunction	Fonction de masquage utilisée pour la règle de masquage des données.
DataMaskingPolicyName	Nom de la base de données à laquelle la règle de masquage des données s’applique.
DataMaskingRule	Règle de masquage des données de base de données.
DataMaskingRuleListResult	Liste des règles de masquage des données de base de données.
DataMaskingRuleState	État de la règle. Utilisé pour supprimer une règle. Pour supprimer une règle existante, spécifiez schemaName, tableName, columnName, maskingFunction, puis spécifiez ruleState comme désactivé. Toutefois, si la règle n’existe pas déjà, la règle est créée avec ruleState défini sur activé, quelle que soit la valeur fournie de ruleState.

DataMaskingFunction

Fonction de masquage utilisée pour la règle de masquage des données.

Nom	Type	Description
CCN	string
Default	string
Email	string
Number	string
SSN	string
Text	string

DataMaskingPolicyName

Nom de la base de données à laquelle la règle de masquage des données s’applique.

Nom	Type	Description
Default	string

DataMaskingRule

Règle de masquage des données de base de données.

Nom	Type	Description
id	string	ID de la ressource
kind	string	Type de règle de masquage des données. Métadonnées, utilisées pour Portail Azure.
location	string	Emplacement de la règle de masquage des données.
name	string	Nom de la ressource.
properties.aliasName	string	Nom de l’alias. Il s’agit d’un paramètre hérité qui n’est plus utilisé.
properties.columnName	string	Nom de colonne sur lequel la règle de masquage des données est appliquée.
properties.id	string	ID de règle.
properties.maskingFunction	DataMaskingFunction	Fonction de masquage utilisée pour la règle de masquage des données.
properties.numberFrom	string	Propriété numberFrom de la règle de masquage. Obligatoire si maskingFunction est défini sur Number, sinon ce paramètre sera ignoré.
properties.numberTo	string	Propriété numberTo de la règle de masquage des données. Obligatoire si maskingFunction est défini sur Number, sinon ce paramètre sera ignoré.
properties.prefixSize	string	Si maskingFunction a la valeur Text, le nombre de caractères à afficher non masqués au début de la chaîne. Sinon, ce paramètre sera ignoré.
properties.replacementString	string	Si maskingFunction a la valeur Text, caractère à utiliser pour masquer la partie non exposée de la chaîne. Sinon, ce paramètre sera ignoré.
properties.ruleState	DataMaskingRuleState	État de la règle. Utilisé pour supprimer une règle. Pour supprimer une règle existante, spécifiez schemaName, tableName, columnName, maskingFunction, puis spécifiez ruleState comme désactivé. Toutefois, si la règle n’existe pas déjà, la règle est créée avec ruleState défini sur activé, quelle que soit la valeur fournie de ruleState.
properties.schemaName	string	Nom de schéma sur lequel la règle de masquage des données est appliquée.
properties.suffixSize	string	Si maskingFunction est défini sur Text, nombre de caractères à afficher non masqués à la fin de la chaîne. Sinon, ce paramètre sera ignoré.
properties.tableName	string	Nom de la table sur laquelle la règle de masquage des données est appliquée.
type	string	Type de ressource.

DataMaskingRuleListResult

Liste des règles de masquage des données de base de données.

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

DataMaskingRuleState

État de la règle. Utilisé pour supprimer une règle. Pour supprimer une règle existante, spécifiez schemaName, tableName, columnName, maskingFunction, puis spécifiez ruleState comme désactivé. Toutefois, si la règle n’existe pas déjà, la règle est créée avec ruleState défini sur activé, quelle que soit la valeur fournie de ruleState.

Nom	Type	Description
Disabled	string
Enabled	string