Data Masking Rules - List By Database

Service:: SQL Database

Version d'API:: 2023-08-01

Obtient la 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=2023-08-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 pour 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	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.

Réponses

Nom	Type	Description
200 OK	DataMaskingRuleListResult	Récupère avec succès la liste des états Advanced Threat Protection du serveur.
Other Status Codes	ErrorResponse	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=2023-08-01

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DataMaskingRuleListByDatabase.json
// this example is just showing the usage of "DataMaskingRules_List" 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 DataMaskingPolicyResource created on azure
// for more information of creating DataMaskingPolicyResource, please refer to the document of DataMaskingPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-6852";
string serverName = "sqlcrudtest-2080";
string databaseName = "sqlcrudtest-331";
DataMaskingPolicyName dataMaskingPolicyName = DataMaskingPolicyName.Default;
ResourceIdentifier dataMaskingPolicyResourceId = DataMaskingPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, dataMaskingPolicyName);
DataMaskingPolicyResource dataMaskingPolicy = client.GetDataMaskingPolicyResource(dataMaskingPolicyResourceId);

// invoke the operation and iterate over the result
await foreach (DataMaskingRule item in dataMaskingPolicy.GetDataMaskingRulesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

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/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 pour 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 et 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.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur

DataMaskingFunction

Énumération

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

Valeur	Description
Default
CCN
Email
Number
SSN
Text

DataMaskingPolicyName

Énumération

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

Valeur	Description
Default

DataMaskingRule

Object

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

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de règle de masquage des données. Métadonnées utilisées pour le 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é et 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 est 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 est ignoré.
properties.prefixSize	string	Si maskingFunction est défini sur Text, le nombre de caractères à afficher non masqués au début de la chaîne. Dans le cas contraire, ce paramètre sera ignoré.
properties.replacementString	string	Si maskingFunction est défini sur Text, le caractère à utiliser pour masquer la partie non exposée de la chaîne. Dans le cas contraire, 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 et 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 du 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, le nombre de caractères à afficher non masqués à la fin de la chaîne. Dans le cas contraire, ce paramètre sera ignoré.
properties.tableName	string	Nom de table sur lequel la règle de masquage des données est appliquée.
type	string	Type de ressource.

DataMaskingRuleListResult

Object

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 suivante des résultats.
value	DataMaskingRule[]	Tableau de résultats.

DataMaskingRuleState

Énumération

État de la règle. Utilisé pour supprimer une règle. Pour supprimer une règle existante, spécifiez schemaName, tableName, columnName, maskingFunction et 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.

Valeur	Description
Enabled
Disabled

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.

Partager via

Data Masking Rules - List By Database

Paramètres URI

Réponses

Exemples

Gets a list of database data masking rules.

Exemple de requête

Exemple de réponse

Définitions

DataMaskingFunction

DataMaskingPolicyName

DataMaskingRule

DataMaskingRuleListResult

DataMaskingRuleState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse