Data Masking Rules - List By Database

服務:: SQL Database

API 版本:: 2023-08-01

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

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

URI 參數

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

回應

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

範例

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=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DataMaskingRuleListByDatabase.json
// this example is just showing the usage of "DataMaskingRules_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataMaskingPolicyResource created on azure
// for more information of creating DataMaskingPolicyResource, please refer to the document of DataMaskingPolicyResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-6852";
string serverName = "sqlcrudtest-2080";
string databaseName = "sqlcrudtest-331";
DataMaskingPolicyName dataMaskingPolicyName = DataMaskingPolicyName.Default;
ResourceIdentifier dataMaskingPolicyResourceId = DataMaskingPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, dataMaskingPolicyName);
DataMaskingPolicyResource dataMaskingPolicy = client.GetDataMaskingPolicyResource(dataMaskingPolicyResourceId);

// invoke the operation and iterate over the result
await foreach (DataMaskingRule item in dataMaskingPolicy.GetDataMaskingRulesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 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 設定為啟用來建立規則。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

DataMaskingFunction

列舉型別

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

值	Description
Default
CCN
Email
Number
SSN
Text

DataMaskingPolicyName

列舉型別

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

值	Description
Default

DataMaskingRule

Object

資料庫數據遮罩規則。

名稱	類型	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

Object

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

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

DataMaskingRuleState

列舉型別

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

值	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

共用方式為

Data Masking Rules - List By Database

URI 參數

回應

範例

Gets a list of database data masking rules.

範例要求

範例回覆

定義

DataMaskingFunction

DataMaskingPolicyName

DataMaskingRule

DataMaskingRuleListResult

DataMaskingRuleState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse