Data Masking Rules - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

Adatbázis-adatmaszkolási szabályt hoz létre vagy frissít.

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-paraméterek

Name	In	Kötelező	Típus	Description
databaseName	path	True	string	Az adatbázis neve.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Annak az adatbázisnak a neve, amelyre az adatmaszkolási szabályzat vonatkozik.
dataMaskingRuleName	path	True	string	Az adatmaszkolási szabály neve.
resourceGroupName	path	True	string	Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string	Az Azure-előfizetést azonosító előfizetés-azonosító.
api-version	query	True	string	A kéréshez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
properties.columnName	True	string	Az oszlop neve, amelyre az adatmaszkolási szabályt alkalmazza.
properties.maskingFunction	True	DataMaskingFunction	Az adatmaszkolási szabályhoz használt maszkoló függvény.
properties.schemaName	True	string	Az a sémanév, amelyre az adatmaszkolási szabályt alkalmazza.
properties.tableName	True	string	A tábla neve, amelyre az adatmaszkolási szabályt alkalmazza.
properties.aliasName		string	Az alias neve. Ez egy örökölt paraméter, és már nem használatos.
properties.numberFrom		string	A maszkolási szabály NumberFrom tulajdonsága. Kötelező, ha a maskingFunction értéke Szám, ellenkező esetben a paraméter figyelmen kívül lesz hagyva.
properties.numberTo		string	Az adatmaszkolási szabály NumberTo tulajdonsága. Kötelező, ha a maskingFunction értéke Szám, ellenkező esetben a paraméter figyelmen kívül lesz hagyva.
properties.prefixSize		string	Ha a maskingFunction értéke Szöveg, a sztring elején maszkolatlan karakterek száma. Ellenkező esetben a rendszer figyelmen kívül hagyja ezt a paramétert.
properties.replacementString		string	Ha a maskingFunction értéke Szöveg, akkor a sztring nem kibontott részének maszkolásához használandó karakter. Ellenkező esetben a rendszer figyelmen kívül hagyja ezt a paramétert.
properties.ruleState		DataMaskingRuleState	A szabály állapota. Szabály törlésére szolgál. Meglévő szabály törléséhez adja meg a schemaName, tableName, columnName, maskingFunction, és adja meg a ruleState értéket letiltottként. Ha azonban a szabály még nem létezik, a szabály a ruleState beállítás engedélyezésével jön létre, függetlenül a ruleState megadott értékétől.
properties.suffixSize		string	Ha a maskingFunction értéke Szöveg, a sztring végén maszkolatlan karakterek száma jelenik meg. Ellenkező esetben a rendszer figyelmen kívül hagyja ezt a paramétert.

Válaszok

Name	Típus	Description
200 OK	DataMaskingRule	Sikerült beállítani egy adatbázis-adatmaszkolási szabályt.
201 Created	DataMaskingRule	Sikeresen létrehozott egy adatbázis-adatmaszkolási szabályt.
Other Status Codes		Hibaválaszok: ***

Példák

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

Definíciók

Name	Description
DataMaskingFunction	Az adatmaszkolási szabályhoz használt maszkoló függvény.
DataMaskingPolicyName	Annak az adatbázisnak a neve, amelyre az adatmaszkolási szabályzat vonatkozik.
DataMaskingRule	Adatbázis-adatmaszkolási szabály.
DataMaskingRuleState	A szabály állapota. Szabály törlésére szolgál. Meglévő szabály törléséhez adja meg a schemaName, tableName, columnName, maskingFunction, és adja meg a ruleState értéket letiltottként. Ha azonban a szabály még nem létezik, a szabály a ruleState beállítás engedélyezésével jön létre, függetlenül a ruleState megadott értékétől.

DataMaskingFunction

Az adatmaszkolási szabályhoz használt maszkoló függvény.

Name	Típus	Description
CCN	string
Default	string
Email	string
Number	string
SSN	string
Text	string

DataMaskingPolicyName

Annak az adatbázisnak a neve, amelyre az adatmaszkolási szabályzat vonatkozik.

Name	Típus	Description
Default	string

DataMaskingRule

Adatbázis-adatmaszkolási szabály.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Az adatmaszkolási szabály típusa. A Azure Portal használt metaadatok.
location	string	Az adatmaszkolási szabály helye.
name	string	Erőforrás neve.
properties.aliasName	string	Az alias neve. Ez egy örökölt paraméter, és már nem használatos.
properties.columnName	string	Az oszlop neve, amelyre az adatmaszkolási szabályt alkalmazza.
properties.id	string	A szabály azonosítója.
properties.maskingFunction	DataMaskingFunction	Az adatmaszkolási szabályhoz használt maszkoló függvény.
properties.numberFrom	string	A maszkolási szabály NumberFrom tulajdonsága. Kötelező, ha a maskingFunction értéke Szám, ellenkező esetben a paraméter figyelmen kívül lesz hagyva.
properties.numberTo	string	Az adatmaszkolási szabály NumberTo tulajdonsága. Kötelező, ha a maskingFunction értéke Szám, ellenkező esetben a paraméter figyelmen kívül lesz hagyva.
properties.prefixSize	string	Ha a maskingFunction értéke Szöveg, a sztring elején maszkolatlan karakterek száma. Ellenkező esetben a rendszer figyelmen kívül hagyja ezt a paramétert.
properties.replacementString	string	Ha a maskingFunction értéke Szöveg, akkor a sztring nem kibontott részének maszkolásához használandó karakter. Ellenkező esetben a rendszer figyelmen kívül hagyja ezt a paramétert.
properties.ruleState	DataMaskingRuleState	A szabály állapota. Szabály törlésére szolgál. Meglévő szabály törléséhez adja meg a schemaName, tableName, columnName, maskingFunction, és adja meg a ruleState értéket letiltottként. Ha azonban a szabály még nem létezik, a szabály a ruleState beállítás engedélyezésével jön létre, függetlenül a ruleState megadott értékétől.
properties.schemaName	string	Az a sémanév, amelyre az adatmaszkolási szabályt alkalmazza.
properties.suffixSize	string	Ha a maskingFunction értéke Szöveg, a sztring végén maszkolatlan karakterek száma jelenik meg. Ellenkező esetben a rendszer figyelmen kívül hagyja ezt a paramétert.
properties.tableName	string	A tábla neve, amelyre az adatmaszkolási szabályt alkalmazza.
type	string	Erőforrástípus.

DataMaskingRuleState

A szabály állapota. Szabály törlésére szolgál. Meglévő szabály törléséhez adja meg a schemaName, tableName, columnName, maskingFunction, és adja meg a ruleState értéket letiltottként. Ha azonban a szabály még nem létezik, a szabály a ruleState beállítás engedélyezésével jön létre, függetlenül a ruleState megadott értékétől.

Name	Típus	Description
Disabled	string
Enabled	string