Data Masking Rules - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Erstellt oder aktualisiert eine Datenbankdatenmaskierungsregel.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
databaseName	path	True	string	Der Name der Datenbank.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Der Name der Datenbank, für die die Datenmaskierungsrichtlinie gilt.
dataMaskingRuleName	path	True	string	Der Name der Datenmaskierungsregel.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.columnName	True	string	Der Spaltenname, auf den die Datenmaskierungsregel angewendet wird.
properties.maskingFunction	True	DataMaskingFunction	Die Maskierungsfunktion, die für die Datenmaskierungsregel verwendet wird.
properties.schemaName	True	string	Der Schemaname, auf den die Datenmaskierungsregel angewendet wird.
properties.tableName	True	string	Der Tabellenname, auf den die Datenmaskierungsregel angewendet wird.
properties.aliasName		string	Der Aliasname. Dies ist ein Legacyparameter und wird nicht mehr verwendet.
properties.numberFrom		string	Die numberFrom-Eigenschaft der Maskierungsregel. Erforderlich, wenn maskingFunction auf Number festgelegt ist, andernfalls wird dieser Parameter ignoriert.
properties.numberTo		string	Die numberTo-Eigenschaft der Datenmaskierungsregel. Erforderlich, wenn maskingFunction auf Number festgelegt ist, andernfalls wird dieser Parameter ignoriert.
properties.prefixSize		string	Wenn maskingFunction auf Text festgelegt ist, ist die Anzahl der Zeichen, die am Anfang der Zeichenfolge unmaskiert angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert.
properties.replacementString		string	Wenn maskingFunction auf Text festgelegt ist, ist das Zeichen, das zum Maskieren des nicht belichteten Teils der Zeichenfolge verwendet werden soll. Andernfalls wird dieser Parameter ignoriert.
properties.ruleState		DataMaskingRuleState	Der Regelstatus. Wird zum Löschen einer Regel verwendet. Um eine vorhandene Regel zu löschen, geben Sie schemaName, tableName, columnName, maskingFunction an, und geben Sie ruleState als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel mit aktiviertem ruleState-Wert erstellt, unabhängig vom angegebenen Wert von ruleState.
properties.suffixSize		string	Wenn maskingFunction auf Text festgelegt ist, ist die Anzahl der Zeichen, die am Ende der Zeichenfolge unmaskiert angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert.

Antworten

Name	Typ	Beschreibung
200 OK	DataMaskingRule	Legen Sie erfolgreich eine Datenbankdatenmaskierungsregel fest.
201 Created	DataMaskingRule	Eine Datenbankdatenmaskierungsregel wurde erfolgreich erstellt.
Other Status Codes		Fehlerantworten: ***

Beispiele

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.

Sample Request

HTTP

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=2021-11-01

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

Java

import com.azure.core.util.Context;
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: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * DataMaskingRuleCreateOrUpdateDefaultMax.json
     */
    /**
     * Sample code: Create/Update data masking rule for default max.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createUpdateDataMaskingRuleForDefaultMax(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().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),
            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

{
  "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": "nickname",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "suffixSize": null,
    "replacementString": null
  }
}

Status code:

201

{
  "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": "nickname",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "suffixSize": null,
    "replacementString": null
  }
}

Create/Update data masking rule for default min.

Sample Request

HTTP

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=2021-11-01

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

Java

import com.azure.core.util.Context;
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: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * DataMaskingRuleCreateOrUpdateDefaultMin.json
     */
    /**
     * Sample code: Create/Update data masking rule for default min.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createUpdateDataMaskingRuleForDefaultMin(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().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),
                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

{
  "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": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "suffixSize": null,
    "replacementString": null
  }
}

Status code:

201

{
  "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": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "suffixSize": null,
    "replacementString": null
  }
}

Create/Update data masking rule for numbers.

Sample Request

HTTP

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=2021-11-01

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

Java

import com.azure.core.util.Context;
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:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DataMaskingRuleCreateOrUpdateNumber.
     * json
     */
    /**
     * Sample code: Create/Update data masking rule for numbers.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createUpdateDataMaskingRuleForNumbers(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().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"),
                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

{
  "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
  }
}

Status code:

201

{
  "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
  }
}

Create/Update data masking rule for text.

Sample Request

HTTP

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=2021-11-01

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

Java

import com.azure.core.util.Context;
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:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DataMaskingRuleCreateOrUpdateText.
     * json
     */
    /**
     * Sample code: Create/Update data masking rule for text.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createUpdateDataMaskingRuleForText(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().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"),
            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

{
  "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"
  }
}

Status code:

201

{
  "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"
  }
}

Definitionen

Name	Beschreibung
DataMaskingFunction	Die Maskierungsfunktion, die für die Datenmaskierungsregel verwendet wird.
DataMaskingPolicyName	Der Name der Datenbank, für die die Datenmaskierungsrichtlinie gilt.
DataMaskingRule	Eine Datenbankdatenmaskierungsregel.
DataMaskingRuleState	Der Regelstatus. Wird zum Löschen einer Regel verwendet. Um eine vorhandene Regel zu löschen, geben Sie schemaName, tableName, columnName, maskingFunction an, und geben Sie ruleState als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel mit aktiviertem ruleState-Wert erstellt, unabhängig vom angegebenen Wert von ruleState.

DataMaskingFunction

Die Maskierungsfunktion, die für die Datenmaskierungsregel verwendet wird.

Name	Typ	Beschreibung
CCN	string
Default	string
Email	string
Number	string
SSN	string
Text	string

DataMaskingPolicyName

Der Name der Datenbank, für die die Datenmaskierungsrichtlinie gilt.

Name	Typ	Beschreibung
Default	string

DataMaskingRule

Eine Datenbankdatenmaskierungsregel.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
kind	string	Die Art der Datenmaskierungsregel. Metadaten, die für Azure-Portal verwendet werden.
location	string	Der Speicherort der Datenmaskierungsregel.
name	string	Name der Ressource.
properties.aliasName	string	Der Aliasname. Dies ist ein Legacyparameter und wird nicht mehr verwendet.
properties.columnName	string	Der Spaltenname, auf den die Datenmaskierungsregel angewendet wird.
properties.id	string	Die Regel-ID.
properties.maskingFunction	DataMaskingFunction	Die Maskierungsfunktion, die für die Datenmaskierungsregel verwendet wird.
properties.numberFrom	string	Die numberFrom-Eigenschaft der Maskierungsregel. Erforderlich, wenn maskingFunction auf Number festgelegt ist, andernfalls wird dieser Parameter ignoriert.
properties.numberTo	string	Die numberTo-Eigenschaft der Datenmaskierungsregel. Erforderlich, wenn maskingFunction auf Number festgelegt ist, andernfalls wird dieser Parameter ignoriert.
properties.prefixSize	string	Wenn maskingFunction auf Text festgelegt ist, ist die Anzahl der Zeichen, die am Anfang der Zeichenfolge unmaskiert angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert.
properties.replacementString	string	Wenn maskingFunction auf Text festgelegt ist, ist das Zeichen, das zum Maskieren des nicht belichteten Teils der Zeichenfolge verwendet werden soll. Andernfalls wird dieser Parameter ignoriert.
properties.ruleState	DataMaskingRuleState	Der Regelstatus. Wird zum Löschen einer Regel verwendet. Um eine vorhandene Regel zu löschen, geben Sie schemaName, tableName, columnName, maskingFunction an, und geben Sie ruleState als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel mit aktiviertem ruleState-Wert erstellt, unabhängig vom angegebenen Wert von ruleState.
properties.schemaName	string	Der Schemaname, auf den die Datenmaskierungsregel angewendet wird.
properties.suffixSize	string	Wenn maskingFunction auf Text festgelegt ist, ist die Anzahl der Zeichen, die am Ende der Zeichenfolge unmaskiert angezeigt werden sollen. Andernfalls wird dieser Parameter ignoriert.
properties.tableName	string	Der Tabellenname, auf den die Datenmaskierungsregel angewendet wird.
type	string	Der Ressourcentyp.

DataMaskingRuleState

Der Regelstatus. Wird zum Löschen einer Regel verwendet. Um eine vorhandene Regel zu löschen, geben Sie schemaName, tableName, columnName, maskingFunction an, und geben Sie ruleState als deaktiviert an. Wenn die Regel jedoch noch nicht vorhanden ist, wird die Regel mit aktiviertem ruleState-Wert erstellt, unabhängig vom angegebenen Wert von ruleState.

Name	Typ	Beschreibung
Disabled	string
Enabled	string