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=2023-08-01
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
database
|
path | True |
string |
資料庫的名稱。 |
|
data
|
path | True |
套用數據遮罩原則的資料庫名稱。 |
|
|
data
|
path | True |
string |
數據遮罩規則的名稱。 |
|
resource
|
path | True |
string |
包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。 |
|
server
|
path | True |
string |
伺服器的名稱。 |
|
subscription
|
path | True |
string |
識別 Azure 訂用帳戶的訂用帳戶標識碼。 |
|
api-version
|
query | True |
string |
要用於要求的 API 版本。 |
要求本文
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| properties.columnName | True |
string |
套用數據遮罩規則的數據行名稱。 |
| properties.maskingFunction | True |
用於數據遮罩規則的遮罩函式。 |
|
| 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 |
規則狀態。 用來刪除規則。 若要刪除現有的規則,請指定 schemaName、tableName、columnName、maskingFunction,以及將 ruleState 指定為停用。 不過,如果規則尚未存在,不論 ruleState 提供的值為何,都會使用 ruleState 設定為啟用來建立規則。 |
||
| properties.suffixSize |
string |
如果 maskingFunction 設定為 Text,則會在字串結尾顯示未遮罩的字元數。 否則,將會忽略此參數。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功設定資料庫數據遮罩規則。 |
|
| 201 Created |
已成功建立資料庫數據遮罩規則。 |
|
| 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=2023-08-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=2023-08-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=2023-08-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=2023-08-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"
}
}
定義
| 名稱 | Description |
|---|---|
|
Data |
用於數據遮罩規則的遮罩函式。 |
|
Data |
套用數據遮罩原則的資料庫名稱。 |
|
Data |
資料庫數據遮罩規則。 |
|
Data |
規則狀態。 用來刪除規則。 若要刪除現有的規則,請指定 schemaName、tableName、columnName、maskingFunction,以及將 ruleState 指定為停用。 不過,如果規則尚未存在,不論 ruleState 提供的值為何,都會使用 ruleState 設定為啟用來建立規則。 |
|
Error |
資源管理錯誤其他資訊。 |
|
Error |
錯誤詳細數據。 |
|
Error |
錯誤回應 |
DataMaskingFunction
用於數據遮罩規則的遮罩函式。
| 值 | Description |
|---|---|
| Default | |
| CCN | |
| Number | |
| SSN | |
| Text |
DataMaskingPolicyName
套用數據遮罩原則的資料庫名稱。
| 值 | Description |
|---|---|
| Default |
DataMaskingRule
資料庫數據遮罩規則。
| 名稱 | 類型 | Description |
|---|---|---|
| id |
string |
資源標識碼。 |
| kind |
string |
數據遮罩規則的類型。 用於 Azure 入口網站的元數據。 |
| location |
string |
數據遮罩規則的位置。 |
| name |
string |
資源名稱。 |
| properties.aliasName |
string |
別名名稱。 這是舊版參數,不再使用。 |
| properties.columnName |
string |
套用數據遮罩規則的數據行名稱。 |
| properties.id |
string |
規則標識碼。 |
| properties.maskingFunction |
用於數據遮罩規則的遮罩函式。 |
|
| properties.numberFrom |
string |
遮罩規則的 numberFrom 屬性。 如果 maskingFunction 設定為 Number,則為必要,否則會忽略此參數。 |
| properties.numberTo |
string |
數據遮罩規則的 numberTo 屬性。 如果 maskingFunction 設定為 Number,則為必要,否則會忽略此參數。 |
| properties.prefixSize |
string |
如果 maskingFunction 設定為 Text,則會在字串開頭顯示未遮罩的字元數。 否則,將會忽略此參數。 |
| properties.replacementString |
string |
如果 maskingFunction 設定為 Text,則用來遮罩字串未公開部分的字元。 否則,將會忽略此參數。 |
| properties.ruleState |
規則狀態。 用來刪除規則。 若要刪除現有的規則,請指定 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 設定為啟用來建立規則。
| 值 | Description |
|---|---|
| Enabled | |
| Disabled |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
object |
其他資訊。 |
| type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤其他資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳細數據。 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
| 名稱 | 類型 | Description |
|---|---|---|
| error |
error 物件。 |