Data Masking Rules - List By Database

參考

Service:: SQL Database

API Version:: 2021-11-01

取得資料庫數據遮罩規則的清單。

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

URI 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	資料庫的名稱。
dataMaskingPolicyName	path	True	DataMaskingPolicyName	套用數據遮罩規則的資料庫名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	DataMaskingRuleListResult	已成功擷取伺服器進階威脅防護狀態的清單。
Other Status Codes		錯誤回應： ≦

範例

Gets a list of database data masking rules.

GET 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?api-version=2021-11-01


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;

/** Samples for DataMaskingRules ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DataMaskingRuleListByDatabase.json
     */
    /**
     * Sample code: Gets a list of database data masking rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabaseDataMaskingRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDataMaskingRules().listByDatabase("sqlcrudtest-6852",
            "sqlcrudtest-2080", "sqlcrudtest-331", DataMaskingPolicyName.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

{
  "value": [
    {
      "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": "Number",
        "numberFrom": "0",
        "numberTo": "2",
        "prefixSize": null,
        "suffixSize": null,
        "replacementString": null
      }
    }
  ]
}

定義

名稱	Description
DataMaskingFunction	用於數據遮罩規則的遮罩函式。
DataMaskingPolicyName	套用數據遮罩規則的資料庫名稱。
DataMaskingRule	資料庫數據遮罩規則。
DataMaskingRuleListResult	資料庫數據遮罩規則的清單。
DataMaskingRuleState	規則狀態。用來刪除規則。若要刪除現有的規則，請指定 schemaName、tableName、columnName、maskingFunction，並將 ruleState 指定為停用。不過，如果規則不存在，不論 ruleState 提供的值為何，規則都會建立為已啟用 ruleState 的規則。

DataMaskingFunction

用於數據遮罩規則的遮罩函式。

名稱	類型	Description
CCN	string
Default	string
Email	string
Number	string
SSN	string
Text	string

DataMaskingPolicyName

套用數據遮罩規則的資料庫名稱。

名稱	類型	Description
Default	string

DataMaskingRule

資料庫數據遮罩規則。

名稱	類型	Description
id	string	資源識別碼。
kind	string	數據遮罩規則的類型。用於 Azure 入口網站的元數據。
location	string	數據遮罩規則的位置。
name	string	資源名稱。
properties.aliasName	string	別名名稱。這是舊版參數，不再使用。
properties.columnName	string	套用數據遮罩規則的數據行名稱。
properties.id	string	規則標識碼。
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	資源類型。

DataMaskingRuleListResult

資料庫數據遮罩規則的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	DataMaskingRule[]	結果陣列。

DataMaskingRuleState

規則狀態。用來刪除規則。若要刪除現有的規則，請指定 schemaName、tableName、columnName、maskingFunction，並將 ruleState 指定為停用。不過，如果規則不存在，不論 ruleState 提供的值為何，規則都會建立為已啟用 ruleState 的規則。

名稱	類型	Description
Disabled	string
Enabled	string