Data Masking Rules - List By Database

Référence

Service:: SQL Database

Version d'API:: 2014-04-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=2014-04-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	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	Ok

Exemples

List data masking rules

Exemple de requête

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=2014-04-01

import com.azure.core.util.Context;

/** Samples for DataMaskingRules ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DataMaskingRuleList.json
     */
    /**
     * Sample code: List data masking rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listDataMaskingRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure
            .sqlServers()
            .manager()
            .serviceClient()
            .getDataMaskingRules()
            .listByDatabase("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", 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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python data_masking_rule_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.data_masking_rules.list_by_database(
        resource_group_name="sqlcrudtest-6852",
        server_name="sqlcrudtest-2080",
        database_name="sqlcrudtest-331",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DataMaskingRuleList.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sql/armsql/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/a3913f4b26467aed413cdc907116e99894f08994/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DataMaskingRuleList.json
func ExampleDataMaskingRulesClient_NewListByDatabasePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDataMaskingRulesClient().NewListByDatabasePager("sqlcrudtest-6852", "sqlcrudtest-2080", "sqlcrudtest-331", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.DataMaskingRuleListResult = armsql.DataMaskingRuleListResult{
		// 	Value: []*armsql.DataMaskingRule{
		// 		{
		// 			Type: to.Ptr("Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
		// 			Location: to.Ptr("Central US"),
		// 			Properties: &armsql.DataMaskingRuleProperties{
		// 				ColumnName: to.Ptr("test1"),
		// 				ID: to.Ptr("dbo_Table_1_test1"),
		// 				MaskingFunction: to.Ptr(armsql.DataMaskingFunctionText),
		// 				PrefixSize: to.Ptr("1"),
		// 				ReplacementString: to.Ptr("asdf"),
		// 				RuleState: to.Ptr(armsql.DataMaskingRuleStateEnabled),
		// 				SchemaName: to.Ptr("dbo"),
		// 				SuffixSize: to.Ptr("0"),
		// 				TableName: to.Ptr("Table_1"),
		// 			},
		// 		},
		// 		{
		// 			Type: to.Ptr("Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/"),
		// 			Location: to.Ptr("Central US"),
		// 			Properties: &armsql.DataMaskingRuleProperties{
		// 				ColumnName: to.Ptr("test1"),
		// 				ID: to.Ptr("dbo_Table_1_test1"),
		// 				MaskingFunction: to.Ptr(armsql.DataMaskingFunctionNumber),
		// 				NumberFrom: to.Ptr("0"),
		// 				NumberTo: to.Ptr("2"),
		// 				RuleState: to.Ptr(armsql.DataMaskingRuleStateEnabled),
		// 				SchemaName: to.Ptr("dbo"),
		// 				TableName: to.Ptr("Table_1"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of database data masking rules.
 *
 * @summary Gets a list of database data masking rules.
 * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/DataMaskingRuleList.json
 */
async function listDataMaskingRules() {
  const subscriptionId =
    process.env["SQL_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SQL_RESOURCE_GROUP"] || "sqlcrudtest-6852";
  const serverName = "sqlcrudtest-2080";
  const databaseName = "sqlcrudtest-331";
  const credential = new DefaultAzureCredential();
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.dataMaskingRules.listByDatabase(
    resourceGroupName,
    serverName,
    databaseName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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/2014-04-01/examples/DataMaskingRuleList.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";
ResourceIdentifier dataMaskingPolicyResourceId = DataMaskingPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
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	Représente une règle de masquage des données de base de données.
DataMaskingRuleListResult	Réponse à une demande de règles de masquage de données de liste.
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 encore, 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 pour laquelle la règle de masquage des données s’applique.

Nom	Type	Description
Default	string

DataMaskingRule

Représente une 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 démasqués au début de la chaîne. Dans le cas contraire, 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. 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 encore, 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 a la valeur Text, le nombre de caractères à afficher démasqués à la fin de la chaîne. Dans le cas contraire, 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

Réponse à une demande de règles de masquage de données de liste.

Nom	Type	Description
value	DataMaskingRule[]	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 encore, 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