Data Masking Rules - Create Or Update

Servizio:: SQL Database

Versione API:: 2025-01-01

Crea o aggiorna una regola di mascheramento dati del database.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
databaseName	path	True	string	Nome del database.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Il nome del database per cui si applica la politica di mascheramento dei dati.
dataMaskingRuleName	path	True	string	Il nome della regola di mascheramento dei dati.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
serverName	path	True	string	Il nome del server.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.columnName	True	string	Nome della colonna in cui viene applicata la regola di maschera dati.
properties.maskingFunction	True	DataMaskingFunction	Funzione di maschera utilizzata per la regola di maschera dati.
properties.schemaName	True	string	Nome dello schema in cui viene applicata la regola di maschera dati.
properties.tableName	True	string	Nome della tabella in cui viene applicata la regola di maschera dati.
properties.aliasName		string	Nome alias. Si tratta di un parametro legacy e non viene più usato.
properties.numberFrom		string	Proprietà numberFrom della regola di mascheramento. Obbligatorio se maskingFunction è impostato su Number. In caso contrario, questo parametro verrà ignorato.
properties.numberTo		string	Proprietà numberTo della regola di maschera dati. Obbligatorio se maskingFunction è impostato su Number. In caso contrario, questo parametro verrà ignorato.
properties.prefixSize		string	Se maskingFunction è impostato su Testo, il numero di caratteri da visualizzare non mascherato all'inizio della stringa. In caso contrario, questo parametro verrà ignorato.
properties.replacementString		string	Se maskingFunction è impostato su Text, il carattere da utilizzare per mascherare la parte non esposta della stringa. In caso contrario, questo parametro verrà ignorato.
properties.ruleState		DataMaskingRuleState	Stato della regola. Consente di eliminare una regola. Per eliminare una regola esistente, specificare schemaName, tableName, columnName, maskingFunction e specificare ruleState come disabilitato. Tuttavia, se la regola non esiste già, la regola verrà creata con ruleState impostato su abilitato, indipendentemente dal valore specificato di ruleState.
properties.suffixSize		string	Se maskingFunction è impostato su Testo, il numero di caratteri da visualizzare non mascherato alla fine della stringa. In caso contrario, questo parametro verrà ignorato.

Risposte

Nome	Tipo	Descrizione
200 OK	DataMaskingRule	Operazione Azure completata con successo.
201 Created	DataMaskingRule	Risorsa 'DataMaskingRule' crea operazione con successo
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create/Update data masking rule for default max.

Create/Update data masking rule for default min.

Create/Update data masking rule for numbers.

Create/Update data masking rule for text.

Create/Update data masking rule for default max.

Esempio di richiesta

PUT 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/rule1?api-version=2025-01-01

{
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "maskingFunction": "Default",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}


import com.azure.resourcemanager.sql.fluent.models.DataMaskingRuleInner;
import com.azure.resourcemanager.sql.models.DataMaskingFunction;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;
import com.azure.resourcemanager.sql.models.DataMaskingRuleState;

/**
 * Samples for DataMaskingRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateDefaultMax.json
     */
    /**
     * Sample code: Create/Update data masking rule for default max.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        createUpdateDataMaskingRuleForDefaultMax(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDataMaskingRules().createOrUpdateWithResponse("sqlcrudtest-6852", "sqlcrudtest-2080",
            "sqlcrudtest-331", DataMaskingPolicyName.DEFAULT, "rule1",
            new DataMaskingRuleInner().withRuleState(DataMaskingRuleState.ENABLED).withSchemaName("dbo")
                .withTableName("Table_1").withColumnName("test1").withAliasName("nickname")
                .withMaskingFunction(DataMaskingFunction.DEFAULT),
            com.azure.core.util.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_create_or_update_default_max.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="SUBSCRIPTION_ID",
    )

    response = client.data_masking_rules.create_or_update(
        resource_group_name="sqlcrudtest-6852",
        server_name="sqlcrudtest-2080",
        database_name="sqlcrudtest-331",
        data_masking_rule_name="rule1",
        parameters={
            "properties": {
                "aliasName": "nickname",
                "columnName": "test1",
                "maskingFunction": "Default",
                "ruleState": "Enabled",
                "schemaName": "dbo",
                "tableName": "Table_1",
            }
        },
    )
    print(response)


# x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateDefaultMax.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

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

/**
 * This sample demonstrates how to creates or updates a database data masking rule.
 *
 * @summary creates or updates a database data masking rule.
 * x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateDefaultMax.json
 */
async function createOrUpdateDataMaskingRuleForDefaultMax() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.dataMaskingRules.createOrUpdate(
    "sqlcrudtest-6852",
    "sqlcrudtest-2080",
    "sqlcrudtest-331",
    "rule1",
    {
      aliasName: "nickname",
      columnName: "test1",
      maskingFunction: "Default",
      ruleState: "Enabled",
      schemaName: "dbo",
      tableName: "Table_1",
    },
  );
  console.log(result);
}

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/SQL/stable/2025-01-01/examples/DataMaskingRuleCreateOrUpdateDefaultMax.json
// this example is just showing the usage of "DataMaskingRules_CreateOrUpdate" 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
string dataMaskingRuleName = "rule1";
DataMaskingRule dataMaskingRule = new DataMaskingRule
{
    RuleState = DataMaskingRuleState.Enabled,
    SchemaName = "dbo",
    TableName = "Table_1",
    ColumnName = "test1",
    AliasName = "nickname",
    MaskingFunction = DataMaskingFunction.Default,
};
DataMaskingRule result = await dataMaskingPolicy.CreateOrUpdateDataMaskingRuleAsync(dataMaskingRuleName, dataMaskingRule);

Console.WriteLine($"Succeeded: {result}");

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

Risposta di esempio

Codice di stato:: 200

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Codice di stato:: 201

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for default min.

Esempio di richiesta

PUT 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/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Default",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}


import com.azure.resourcemanager.sql.fluent.models.DataMaskingRuleInner;
import com.azure.resourcemanager.sql.models.DataMaskingFunction;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;

/**
 * Samples for DataMaskingRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateDefaultMin.json
     */
    /**
     * Sample code: Create/Update data masking rule for default min.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        createUpdateDataMaskingRuleForDefaultMin(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDataMaskingRules().createOrUpdateWithResponse("sqlcrudtest-6852", "sqlcrudtest-2080",
            "sqlcrudtest-331", DataMaskingPolicyName.DEFAULT, "rule1", new DataMaskingRuleInner().withSchemaName("dbo")
                .withTableName("Table_1").withColumnName("test1").withMaskingFunction(DataMaskingFunction.DEFAULT),
            com.azure.core.util.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_create_or_update_default_min.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="SUBSCRIPTION_ID",
    )

    response = client.data_masking_rules.create_or_update(
        resource_group_name="sqlcrudtest-6852",
        server_name="sqlcrudtest-2080",
        database_name="sqlcrudtest-331",
        data_masking_rule_name="rule1",
        parameters={
            "properties": {
                "columnName": "test1",
                "maskingFunction": "Default",
                "schemaName": "dbo",
                "tableName": "Table_1",
            }
        },
    )
    print(response)


# x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateDefaultMin.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

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

/**
 * This sample demonstrates how to creates or updates a database data masking rule.
 *
 * @summary creates or updates a database data masking rule.
 * x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateDefaultMin.json
 */
async function createOrUpdateDataMaskingRuleForDefaultMin() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.dataMaskingRules.createOrUpdate(
    "sqlcrudtest-6852",
    "sqlcrudtest-2080",
    "sqlcrudtest-331",
    "rule1",
    { columnName: "test1", maskingFunction: "Default", schemaName: "dbo", tableName: "Table_1" },
  );
  console.log(result);
}

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/SQL/stable/2025-01-01/examples/DataMaskingRuleCreateOrUpdateDefaultMin.json
// this example is just showing the usage of "DataMaskingRules_CreateOrUpdate" 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
string dataMaskingRuleName = "rule1";
DataMaskingRule dataMaskingRule = new DataMaskingRule
{
    SchemaName = "dbo",
    TableName = "Table_1",
    ColumnName = "test1",
    MaskingFunction = DataMaskingFunction.Default,
};
DataMaskingRule result = await dataMaskingPolicy.CreateOrUpdateDataMaskingRuleAsync(dataMaskingRuleName, dataMaskingRule);

Console.WriteLine($"Succeeded: {result}");

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

Risposta di esempio

Codice di stato:: 200

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Codice di stato:: 201

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for numbers.

Esempio di richiesta

PUT 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/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}


import com.azure.resourcemanager.sql.fluent.models.DataMaskingRuleInner;
import com.azure.resourcemanager.sql.models.DataMaskingFunction;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;

/**
 * Samples for DataMaskingRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateNumber.json
     */
    /**
     * Sample code: Create/Update data masking rule for numbers.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void createUpdateDataMaskingRuleForNumbers(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDataMaskingRules().createOrUpdateWithResponse("sqlcrudtest-6852", "sqlcrudtest-2080",
            "sqlcrudtest-331", DataMaskingPolicyName.DEFAULT, "rule1",
            new DataMaskingRuleInner().withSchemaName("dbo").withTableName("Table_1").withColumnName("test1")
                .withMaskingFunction(DataMaskingFunction.NUMBER).withNumberFrom("0").withNumberTo("2"),
            com.azure.core.util.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_create_or_update_number.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="SUBSCRIPTION_ID",
    )

    response = client.data_masking_rules.create_or_update(
        resource_group_name="sqlcrudtest-6852",
        server_name="sqlcrudtest-2080",
        database_name="sqlcrudtest-331",
        data_masking_rule_name="rule1",
        parameters={
            "properties": {
                "columnName": "test1",
                "maskingFunction": "Number",
                "numberFrom": "0",
                "numberTo": "2",
                "schemaName": "dbo",
                "tableName": "Table_1",
            }
        },
    )
    print(response)


# x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateNumber.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

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

/**
 * This sample demonstrates how to creates or updates a database data masking rule.
 *
 * @summary creates or updates a database data masking rule.
 * x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateNumber.json
 */
async function createOrUpdateDataMaskingRuleForNumbers() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.dataMaskingRules.createOrUpdate(
    "sqlcrudtest-6852",
    "sqlcrudtest-2080",
    "sqlcrudtest-331",
    "rule1",
    {
      columnName: "test1",
      maskingFunction: "Number",
      numberFrom: "0",
      numberTo: "2",
      schemaName: "dbo",
      tableName: "Table_1",
    },
  );
  console.log(result);
}

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/SQL/stable/2025-01-01/examples/DataMaskingRuleCreateOrUpdateNumber.json
// this example is just showing the usage of "DataMaskingRules_CreateOrUpdate" 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
string dataMaskingRuleName = "rule1";
DataMaskingRule dataMaskingRule = new DataMaskingRule
{
    SchemaName = "dbo",
    TableName = "Table_1",
    ColumnName = "test1",
    MaskingFunction = DataMaskingFunction.Number,
    NumberFrom = "0",
    NumberTo = "2",
};
DataMaskingRule result = await dataMaskingPolicy.CreateOrUpdateDataMaskingRuleAsync(dataMaskingRuleName, dataMaskingRule);

Console.WriteLine($"Succeeded: {result}");

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

Risposta di esempio

Codice di stato:: 200

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Codice di stato:: 201

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for text.

Esempio di richiesta

PUT 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/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Text",
    "prefixSize": "1",
    "replacementString": "asdf",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}


import com.azure.resourcemanager.sql.fluent.models.DataMaskingRuleInner;
import com.azure.resourcemanager.sql.models.DataMaskingFunction;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;

/**
 * Samples for DataMaskingRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateText.json
     */
    /**
     * Sample code: Create/Update data masking rule for text.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void createUpdateDataMaskingRuleForText(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDataMaskingRules().createOrUpdateWithResponse("sqlcrudtest-6852", "sqlcrudtest-2080",
            "sqlcrudtest-331", DataMaskingPolicyName.DEFAULT, "rule1",
            new DataMaskingRuleInner().withSchemaName("dbo").withTableName("Table_1").withColumnName("test1")
                .withMaskingFunction(DataMaskingFunction.TEXT).withPrefixSize("1").withSuffixSize("0")
                .withReplacementString("asdf"),
            com.azure.core.util.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_create_or_update_text.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="SUBSCRIPTION_ID",
    )

    response = client.data_masking_rules.create_or_update(
        resource_group_name="sqlcrudtest-6852",
        server_name="sqlcrudtest-2080",
        database_name="sqlcrudtest-331",
        data_masking_rule_name="rule1",
        parameters={
            "properties": {
                "columnName": "test1",
                "maskingFunction": "Text",
                "prefixSize": "1",
                "replacementString": "asdf",
                "schemaName": "dbo",
                "suffixSize": "0",
                "tableName": "Table_1",
            }
        },
    )
    print(response)


# x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateText.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

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

/**
 * This sample demonstrates how to creates or updates a database data masking rule.
 *
 * @summary creates or updates a database data masking rule.
 * x-ms-original-file: 2025-01-01/DataMaskingRuleCreateOrUpdateText.json
 */
async function createOrUpdateDataMaskingRuleForText() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.dataMaskingRules.createOrUpdate(
    "sqlcrudtest-6852",
    "sqlcrudtest-2080",
    "sqlcrudtest-331",
    "rule1",
    {
      columnName: "test1",
      maskingFunction: "Text",
      prefixSize: "1",
      replacementString: "asdf",
      schemaName: "dbo",
      suffixSize: "0",
      tableName: "Table_1",
    },
  );
  console.log(result);
}

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/SQL/stable/2025-01-01/examples/DataMaskingRuleCreateOrUpdateText.json
// this example is just showing the usage of "DataMaskingRules_CreateOrUpdate" 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
string dataMaskingRuleName = "rule1";
DataMaskingRule dataMaskingRule = new DataMaskingRule
{
    SchemaName = "dbo",
    TableName = "Table_1",
    ColumnName = "test1",
    MaskingFunction = DataMaskingFunction.Text,
    PrefixSize = "1",
    SuffixSize = "0",
    ReplacementString = "asdf",
};
DataMaskingRule result = await dataMaskingPolicy.CreateOrUpdateDataMaskingRuleAsync(dataMaskingRuleName, dataMaskingRule);

Console.WriteLine($"Succeeded: {result}");

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

Risposta di esempio

Codice di stato:: 200

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "replacementString": "asdf",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}

Codice di stato:: 201

{
  "name": null,
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "replacementString": "asdf",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
DataMaskingFunction	Funzione di maschera utilizzata per la regola di maschera dati.
DataMaskingPolicyName	Il nome del database per cui si applica la politica di mascheramento dei dati.
DataMaskingRule	Una regola di mascheramento dei dati del database.
DataMaskingRuleState	Stato della regola. Consente di eliminare una regola. Per eliminare una regola esistente, specificare schemaName, tableName, columnName, maskingFunction e specificare ruleState come disabilitato. Tuttavia, se la regola non esiste già, la regola verrà creata con ruleState impostato su abilitato, indipendentemente dal valore specificato di ruleState.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

DataMaskingFunction

Enumerazione

Funzione di maschera utilizzata per la regola di maschera dati.

Valore	Descrizione
Default	Valore predefinito
CCN	CCN
Email	Email
Number	Number
SSN	NPS (Numero di Previdenza Sociale)
Text	Text

DataMaskingPolicyName

Enumerazione

Il nome del database per cui si applica la politica di mascheramento dei dati.

Valore	Descrizione
Default	Valore predefinito

DataMaskingRule

Oggetto

Una regola di mascheramento dei dati del database.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Il tipo di regola del mascheramento dati. Metadati, utilizzati per il portale Azure.
location	string	La posizione della regola di mascheramento dei dati.
name	string	Nome della risorsa
properties.aliasName	string	Nome alias. Si tratta di un parametro legacy e non viene più usato.
properties.columnName	string	Nome della colonna in cui viene applicata la regola di maschera dati.
properties.id	string	La regola Id.
properties.maskingFunction	DataMaskingFunction	Funzione di maschera utilizzata per la regola di maschera dati.
properties.numberFrom	string	Proprietà numberFrom della regola di mascheramento. Obbligatorio se maskingFunction è impostato su Number. In caso contrario, questo parametro verrà ignorato.
properties.numberTo	string	Proprietà numberTo della regola di maschera dati. Obbligatorio se maskingFunction è impostato su Number. In caso contrario, questo parametro verrà ignorato.
properties.prefixSize	string	Se maskingFunction è impostato su Testo, il numero di caratteri da visualizzare non mascherato all'inizio della stringa. In caso contrario, questo parametro verrà ignorato.
properties.replacementString	string	Se maskingFunction è impostato su Text, il carattere da utilizzare per mascherare la parte non esposta della stringa. In caso contrario, questo parametro verrà ignorato.
properties.ruleState	DataMaskingRuleState	Stato della regola. Consente di eliminare una regola. Per eliminare una regola esistente, specificare schemaName, tableName, columnName, maskingFunction e specificare ruleState come disabilitato. Tuttavia, se la regola non esiste già, la regola verrà creata con ruleState impostato su abilitato, indipendentemente dal valore specificato di ruleState.
properties.schemaName	string	Nome dello schema in cui viene applicata la regola di maschera dati.
properties.suffixSize	string	Se maskingFunction è impostato su Testo, il numero di caratteri da visualizzare non mascherato alla fine della stringa. In caso contrario, questo parametro verrà ignorato.
properties.tableName	string	Nome della tabella in cui viene applicata la regola di maschera dati.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

DataMaskingRuleState

Enumerazione

Stato della regola. Consente di eliminare una regola. Per eliminare una regola esistente, specificare schemaName, tableName, columnName, maskingFunction e specificare ruleState come disabilitato. Tuttavia, se la regola non esiste già, la regola verrà creata con ruleState impostato su abilitato, indipendentemente dal valore specificato di ruleState.

Valore	Descrizione
Enabled	Enabled
Disabled	Disattivato

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.