你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Data Masking Policies - Create Or Update

参考

服务:: SQL Database

API 版本:: 2023-08-01

创建或更新数据库数据掩码策略。

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

URI 参数

名称	在	必需	类型	说明
databaseName	path	True	string	数据库的名称。
dataMaskingPolicyName	path	True	DataMaskingPolicyName	应用数据掩码策略的数据库的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。

请求正文

名称	必需	类型	说明
properties.dataMaskingState	True	DataMaskingState	数据掩码策略的状态。
properties.exemptPrincipals		string	豁免主体的列表。指定数据掩码策略不适用的数据库用户的分号分隔列表。指定的用户接收数据结果，而不会屏蔽所有数据库查询。

响应

名称	类型	说明
200 OK	DataMaskingPolicy	已成功创建数据库数据掩码策略。
201 Created	DataMaskingPolicy	已成功创建数据库数据掩码策略。
Other Status Codes	ErrorResponse	错误响应： *** 400 InvalidDatabaseNameForDataMaskingOperation - 无法将数据掩码策略和规则直接应用于 master 数据库。数据掩码策略/规则仅适用于用户数据库。

名称

类型

说明

200 OK

DataMaskingPolicy

已成功创建数据库数据掩码策略。

201 Created

DataMaskingPolicy

已成功创建数据库数据掩码策略。

Other Status Codes

ErrorResponse

错误响应： ***

400 InvalidDatabaseNameForDataMaskingOperation - 无法将数据掩码策略和规则直接应用于 master 数据库。数据掩码策略/规则仅适用于用户数据库。

示例

Create or update data masking policy max

Create or update data masking policy min.

Create or update data masking policy 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?api-version=2023-08-01

{
  "properties": {
    "dataMaskingState": "Enabled",
    "exemptPrincipals": "testuser;"
  }
}

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/DataMaskingPolicyCreateOrUpdateMax.json
// this example is just showing the usage of "DataMaskingPolicies_CreateOrUpdate" 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
DataMaskingPolicyData data = new DataMaskingPolicyData
{
    DataMaskingState = DataMaskingState.Enabled,
    ExemptPrincipals = "testuser;",
};
ArmOperation<DataMaskingPolicyResource> lro = await dataMaskingPolicy.UpdateAsync(WaitUntil.Completed, data);
DataMaskingPolicyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataMaskingPolicyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies",
  "___location": "Central US",
  "kind": null,
  "properties": {
    "dataMaskingState": "Enabled",
    "applicationPrincipals": "",
    "exemptPrincipals": "testuser;",
    "maskingLevel": ""
  }
}

状态代码:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies",
  "___location": "Central US",
  "kind": null,
  "properties": {
    "dataMaskingState": "Enabled",
    "applicationPrincipals": "",
    "exemptPrincipals": "testuser;",
    "maskingLevel": ""
  }
}

Create or update data masking policy min.

示例请求

HTTP
dotnet

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

{
  "properties": {
    "dataMaskingState": "Enabled"
  }
}

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/DataMaskingPolicyCreateOrUpdateMin.json
// this example is just showing the usage of "DataMaskingPolicies_CreateOrUpdate" 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
DataMaskingPolicyData data = new DataMaskingPolicyData
{
    DataMaskingState = DataMaskingState.Enabled,
};
ArmOperation<DataMaskingPolicyResource> lro = await dataMaskingPolicy.UpdateAsync(WaitUntil.Completed, data);
DataMaskingPolicyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataMaskingPolicyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

示例响应

状态代码:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies",
  "___location": "Central US",
  "kind": null,
  "properties": {
    "dataMaskingState": "Enabled",
    "applicationPrincipals": "",
    "exemptPrincipals": "",
    "maskingLevel": ""
  }
}

状态代码:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies",
  "___location": "Central US",
  "kind": null,
  "properties": {
    "dataMaskingState": "Enabled",
    "applicationPrincipals": "",
    "exemptPrincipals": "",
    "maskingLevel": ""
  }
}

定义

名称	说明
DataMaskingPolicy	数据库数据掩码策略。
DataMaskingPolicyName	应用数据掩码策略的数据库的名称。
DataMaskingState	数据掩码策略的状态。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应

DataMaskingPolicy

Object

数据库数据掩码策略。

名称	类型	说明
id	string	资源 ID。
kind	string	数据掩码策略的类型。用于 Azure 门户的元数据。
___location	string	数据掩码策略的位置。
name	string	资源名称。
properties.applicationPrincipals	string	应用程序主体的列表。这是一个旧参数，不再使用。
properties.dataMaskingState	DataMaskingState	数据掩码策略的状态。
properties.exemptPrincipals	string	豁免主体的列表。指定数据掩码策略不适用的数据库用户的分号分隔列表。指定的用户接收数据结果，而不会屏蔽所有数据库查询。
properties.maskingLevel	string	掩码级别。这是一个旧参数，不再使用。
type	string	资源类型。

DataMaskingPolicyName

枚举

应用数据掩码策略的数据库的名称。

值	说明
Default

DataMaskingState

枚举

数据掩码策略的状态。

值	说明
Disabled
Enabled

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

通过

Data Masking Policies - Create Or Update

URI 参数

请求正文

响应

示例

Create or update data masking policy max

示例请求

示例响应

Create or update data masking policy min.

示例请求

示例响应

定义

DataMaskingPolicy

DataMaskingPolicyName

DataMaskingState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse