Data Masking Rules - Create Or Update

データベース データ マスク ルールを作成または更新します。

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 パラメーター

名前 / 必須 説明
databaseName
path True

string

データベースの名前。

dataMaskingPolicyName
path True

DataMaskingPolicyName

データ マスク ポリシーが適用されるデータベースの名前。

dataMaskingRuleName
path True

string

データ マスク ルールの名前。

resourceGroupName
path True

string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

serverName
path True

string

サーバーの名前。

subscriptionId
path True

string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True

string

要求で使用する API のバージョン。

要求本文

名前 必須 説明
properties.columnName True

string

データ マスク ルールが適用される列名。

properties.maskingFunction True

DataMaskingFunction

データ マスク ルールに使用されるマスク関数。

properties.schemaName True

string

データ マスク ルールが適用されるスキーマ名。

properties.tableName True

string

データ マスク ルールが適用されるテーブル名。

properties.aliasName

string

エイリアス名。 これはレガシ パラメーターであり、使用されなくなりました。

properties.numberFrom

string

マスク ルールの numberFrom プロパティ。 maskingFunction が Number に設定されている場合は必須。それ以外の場合、このパラメーターは無視されます。

properties.numberTo

string

データ マスク ルールの numberTo プロパティ。 maskingFunction が Number に設定されている場合は必須。それ以外の場合、このパラメーターは無視されます。

properties.prefixSize

string

maskingFunction が Text に設定されている場合、文字列の先頭にマスクされていない文字の数が表示されます。 それ以外の場合、このパラメーターは無視されます。

properties.replacementString

string

maskingFunction が Text に設定されている場合、文字列の露出されていない部分をマスクするために使用する文字。 それ以外の場合、このパラメーターは無視されます。

properties.ruleState

DataMaskingRuleState

ルールの状態。 ルールを削除するために使用されます。 既存のルールを削除するには、schemaName、tableName、columnName、maskingFunction を指定し、ruleState を無効として指定します。 ただし、ルールがまだ存在しない場合は、ruleState の指定された値に関係なく、ruleState が有効に設定されたルールが作成されます。

properties.suffixSize

string

maskingFunction が Text に設定されている場合、文字列の末尾にマスクされていない文字を表示する文字数。 それ以外の場合、このパラメーターは無視されます。

応答

名前 説明
200 OK

DataMaskingRule

データベース データ マスク ルールを正常に設定しました。

201 Created

DataMaskingRule

データベース データ マスク ルールが正常に作成されました。

Other Status Codes

エラー応答: ***

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.

要求のサンプル

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

応答のサンプル

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

要求のサンプル

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

応答のサンプル

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

要求のサンプル

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

応答のサンプル

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

要求のサンプル

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

応答のサンプル

{
  "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": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "suffixSize": "0",
    "replacementString": "asdf"
  }
}

定義

名前 説明
DataMaskingFunction

データ マスク ルールに使用されるマスク関数。

DataMaskingPolicyName

データ マスク ポリシーが適用されるデータベースの名前。

DataMaskingRule

データベース データ マスク ルール。

DataMaskingRuleState

ルールの状態。 ルールを削除するために使用されます。 既存のルールを削除するには、schemaName、tableName、columnName、maskingFunction を指定し、ruleState を無効として指定します。 ただし、ルールがまだ存在しない場合は、ruleState の指定された値に関係なく、ruleState が有効に設定されたルールが作成されます。

DataMaskingFunction

データ マスク ルールに使用されるマスク関数。

名前 説明
CCN

string

Default

string

Email

string

Number

string

SSN

string

Text

string

DataMaskingPolicyName

データ マスク ポリシーが適用されるデータベースの名前。

名前 説明
Default

string

DataMaskingRule

データベース データ マスク ルール。

名前 説明
id

string

リソースの ID

kind

string

データ マスク ルールの種類。 Azure portalに使用されるメタデータ。

location

string

データ マスク ルールの場所。

name

string

リソース名。

properties.aliasName

string

エイリアス名。 これはレガシ パラメーターであり、使用されなくなりました。

properties.columnName

string

データ マスク ルールが適用される列名。

properties.id

string

ルール ID。

properties.maskingFunction

DataMaskingFunction

データ マスク ルールに使用されるマスク関数。

properties.numberFrom

string

マスク ルールの numberFrom プロパティ。 maskingFunction が Number に設定されている場合は必須。それ以外の場合、このパラメーターは無視されます。

properties.numberTo

string

データ マスク ルールの numberTo プロパティ。 maskingFunction が Number に設定されている場合は必須。それ以外の場合、このパラメーターは無視されます。

properties.prefixSize

string

maskingFunction が Text に設定されている場合、文字列の先頭にマスクされていない文字の数が表示されます。 それ以外の場合、このパラメーターは無視されます。

properties.replacementString

string

maskingFunction が Text に設定されている場合、文字列の露出されていない部分をマスクするために使用する文字。 それ以外の場合、このパラメーターは無視されます。

properties.ruleState

DataMaskingRuleState

ルールの状態。 ルールを削除するために使用されます。 既存のルールを削除するには、schemaName、tableName、columnName、maskingFunction を指定し、ruleState を無効として指定します。 ただし、ルールがまだ存在しない場合は、ruleState の指定された値に関係なく、ruleState が有効に設定されたルールが作成されます。

properties.schemaName

string

データ マスク ルールが適用されるスキーマ名。

properties.suffixSize

string

maskingFunction が Text に設定されている場合、文字列の末尾にマスクされていない文字を表示する文字数。 それ以外の場合、このパラメーターは無視されます。

properties.tableName

string

データ マスク ルールが適用されるテーブル名。

type

string

リソースの種類。

DataMaskingRuleState

ルールの状態。 ルールを削除するために使用されます。 既存のルールを削除するには、schemaName、tableName、columnName、maskingFunction を指定し、ruleState を無効として指定します。 ただし、ルールがまだ存在しない場合は、ruleState の指定された値に関係なく、ruleState が有効に設定されたルールが作成されます。

名前 説明
Disabled

string

Enabled

string