Compartilhar via

Data Masking Policies - Create Or Update

Serviço:
SQL Database
Versão da API:
2025-01-01

Cria ou atualiza uma política de mascaramento de dados de banco de dados.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
databaseName
 path True

string

O nome do banco de dados.
dataMaskingPolicyName
 path True

DataMaskingPolicyName

O nome do banco de dados para o qual a política de mascaramento de dados se aplica.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
serverName
 path True

string

O nome do servidor.
subscriptionId
 path True

string

A ID da assinatura que identifica uma assinatura do Azure.
api-version
 query True

string

A versão da API a ser usada para a solicitação.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.dataMaskingState True

DataMaskingState

O estado da política de mascaramento de dados.
properties.exemptPrincipals

string

A lista de entidades de segurança isentas. Especifica a lista separada por ponto-e-vírgula de usuários de banco de dados para os quais a política de mascaramento de dados não se aplica. Os usuários especificados recebem resultados de dados sem mascaramento para todas as consultas de banco de dados.

Respostas

Nome Tipo Description
200 OK

DataMaskingPolicy

Criei com sucesso a política de mascaramento de dados de banco de dados.
201 Created

DataMaskingPolicy

Criei com sucesso a política de mascaramento de dados de banco de dados..
Other Status Codes

ErrorResponse

Respostas de erro: ***

  • 400 InvalidDatabaseNameForDataMaskingOperation - Não é possível aplicar a política e as regras de mascaramento de dados diretamente ao banco de dados mestre. A política/regras de mascaramento de dados são aplicáveis apenas ao banco de dados dos usuários.

Exemplos

Create or update data masking policy max
Create or update data masking policy min.

Create or update data masking policy max

Solicitação de exemplo

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=2025-01-01

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

Resposta de exemplo

Código de status:
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": ""
  }
}
Código de status:
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.

Solicitação de exemplo

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=2025-01-01

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

Resposta de exemplo

Código de status:
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": ""
  }
}
Código de status:
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": ""
  }
}

Definições

Nome Description
DataMaskingPolicy

Uma política de mascaramento de dados em banco de dados.
DataMaskingPolicyName

O nome do banco de dados para o qual a política de mascaramento de dados se aplica.
DataMaskingState

O estado da política de mascaramento de dados.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro

DataMaskingPolicy

Objeto

Uma política de mascaramento de dados em banco de dados.

Nome Tipo Description
id

string

ID do recurso.
kind

string

O tipo de Política de Mascaramento de Dados. Metadados, usados para o portal Azure.
location

string

A localização da política de dados sobre máscara.
name

string

Nome do recurso.
properties.applicationPrincipals

string

A lista dos principais da aplicação. Esse é um parâmetro herdado e não é mais usado.
properties.dataMaskingState

DataMaskingState

O estado da política de mascaramento de dados.
properties.exemptPrincipals

string

A lista de entidades de segurança isentas. Especifica a lista separada por ponto-e-vírgula de usuários de banco de dados para os quais a política de mascaramento de dados não se aplica. Os usuários especificados recebem resultados de dados sem mascaramento para todas as consultas de banco de dados.
properties.maskingLevel

string

O nível de mascaramento. Esse é um parâmetro herdado e não é mais usado.
type

string

Tipo de recurso.

DataMaskingPolicyName

Enumeração

O nome do banco de dados para o qual a política de mascaramento de dados se aplica.

Valor Description
Default

DataMaskingState

Enumeração

O estado da política de mascaramento de dados.

Valor Description
Enabled
Disabled

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.