Compartilhar via


Data Masking Rules - Create Or Update

Cria ou atualiza uma regra 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/rules/{dataMaskingRuleName}?api-version=2021-11-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.

dataMaskingRuleName
path True

string

O nome da regra de mascaramento de dados.

resourceGroupName
path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.

serverName
path True

string

O nome do servidor.

subscriptionId
path True

string

A ID de 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.columnName True

string

O nome da coluna na qual a regra de mascaramento de dados é aplicada.

properties.maskingFunction True

DataMaskingFunction

A função de mascaramento usada para a regra de mascaramento de dados.

properties.schemaName True

string

O nome do esquema no qual a regra de mascaramento de dados é aplicada.

properties.tableName True

string

O nome da tabela na qual a regra de mascaramento de dados é aplicada.

properties.aliasName

string

O nome do alias. Esse é um parâmetro herdado e não é mais usado.

properties.numberFrom

string

A propriedade numberFrom da regra de mascaramento. Obrigatório se maskingFunction estiver definido como Número; caso contrário, esse parâmetro será ignorado.

properties.numberTo

string

A propriedade numberTo da regra de mascaramento de dados. Obrigatório se maskingFunction estiver definido como Número; caso contrário, esse parâmetro será ignorado.

properties.prefixSize

string

Se maskingFunction for definido como Texto, o número de caracteres a serem exibidos sem máscara no início da cadeia de caracteres. Caso contrário, esse parâmetro será ignorado.

properties.replacementString

string

Se maskingFunction estiver definido como Texto, o caractere a ser usado para mascarar a parte nãoexposta da cadeia de caracteres. Caso contrário, esse parâmetro será ignorado.

properties.ruleState

DataMaskingRuleState

O estado da regra. Usado para excluir uma regra. Para excluir uma regra existente, especifique schemaName, tableName, columnName, maskingFunction e especifique ruleState como desabilitado. No entanto, se a regra ainda não existir, a regra será criada com ruleState definido como habilitado, independentemente do valor fornecido de ruleState.

properties.suffixSize

string

Se maskingFunction estiver definido como Texto, o número de caracteres a serem exibidos sem máscara no final da cadeia de caracteres. Caso contrário, esse parâmetro será ignorado.

Respostas

Nome Tipo Description
200 OK

DataMaskingRule

Defina com êxito uma regra de mascaramento de dados de banco de dados.

201 Created

DataMaskingRule

Criou com êxito uma regra de mascaramento de dados de banco de dados.

Other Status Codes

Respostas de erro: ***

Exemplos

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.

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/rules/rule1?api-version=2021-11-01

{
  "properties": {
    "aliasName": "nickname",
    "schemaName": "dbo",
    "tableName": "Table_1",
    "columnName": "test1",
    "maskingFunction": "Default",
    "ruleState": "Enabled"
  }
}

Resposta de exemplo

{
  "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.

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/rules/rule1?api-version=2021-11-01

{
  "properties": {
    "schemaName": "dbo",
    "tableName": "Table_1",
    "columnName": "test1",
    "maskingFunction": "Default"
  }
}

Resposta de exemplo

{
  "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.

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/rules/rule1?api-version=2021-11-01

{
  "properties": {
    "schemaName": "dbo",
    "tableName": "Table_1",
    "columnName": "test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2"
  }
}

Resposta de exemplo

{
  "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.

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/rules/rule1?api-version=2021-11-01

{
  "properties": {
    "schemaName": "dbo",
    "tableName": "Table_1",
    "columnName": "test1",
    "maskingFunction": "Text",
    "prefixSize": "1",
    "suffixSize": "0",
    "replacementString": "asdf"
  }
}

Resposta de exemplo

{
  "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"
  }
}

Definições

Nome Description
DataMaskingFunction

A função de mascaramento usada para a regra de mascaramento de dados.

DataMaskingPolicyName

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

DataMaskingRule

Uma regra de mascaramento de dados de banco de dados.

DataMaskingRuleState

O estado da regra. Usado para excluir uma regra. Para excluir uma regra existente, especifique schemaName, tableName, columnName, maskingFunction e especifique ruleState como desabilitado. No entanto, se a regra ainda não existir, a regra será criada com ruleState definido como habilitado, independentemente do valor fornecido de ruleState.

DataMaskingFunction

A função de mascaramento usada para a regra de mascaramento de dados.

Nome Tipo Description
CCN

string

Default

string

Email

string

Number

string

SSN

string

Text

string

DataMaskingPolicyName

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

Nome Tipo Description
Default

string

DataMaskingRule

Uma regra de mascaramento de dados de banco de dados.

Nome Tipo Description
id

string

ID do recurso.

kind

string

O tipo de regra de mascaramento de dados. Metadados, usados para portal do Azure.

location

string

O local da regra de mascaramento de dados.

name

string

Nome do recurso.

properties.aliasName

string

O nome do alias. Esse é um parâmetro herdado e não é mais usado.

properties.columnName

string

O nome da coluna na qual a regra de mascaramento de dados é aplicada.

properties.id

string

A ID da regra.

properties.maskingFunction

DataMaskingFunction

A função de mascaramento usada para a regra de mascaramento de dados.

properties.numberFrom

string

A propriedade numberFrom da regra de mascaramento. Obrigatório se maskingFunction estiver definido como Número; caso contrário, esse parâmetro será ignorado.

properties.numberTo

string

A propriedade numberTo da regra de mascaramento de dados. Obrigatório se maskingFunction estiver definido como Número; caso contrário, esse parâmetro será ignorado.

properties.prefixSize

string

Se maskingFunction for definido como Texto, o número de caracteres a serem exibidos sem máscara no início da cadeia de caracteres. Caso contrário, esse parâmetro será ignorado.

properties.replacementString

string

Se maskingFunction estiver definido como Texto, o caractere a ser usado para mascarar a parte nãoexposta da cadeia de caracteres. Caso contrário, esse parâmetro será ignorado.

properties.ruleState

DataMaskingRuleState

O estado da regra. Usado para excluir uma regra. Para excluir uma regra existente, especifique schemaName, tableName, columnName, maskingFunction e especifique ruleState como desabilitado. No entanto, se a regra ainda não existir, a regra será criada com ruleState definido como habilitado, independentemente do valor fornecido de ruleState.

properties.schemaName

string

O nome do esquema no qual a regra de mascaramento de dados é aplicada.

properties.suffixSize

string

Se maskingFunction estiver definido como Texto, o número de caracteres a serem exibidos sem máscara no final da cadeia de caracteres. Caso contrário, esse parâmetro será ignorado.

properties.tableName

string

O nome da tabela na qual a regra de mascaramento de dados é aplicada.

type

string

Tipo de recurso.

DataMaskingRuleState

O estado da regra. Usado para excluir uma regra. Para excluir uma regra existente, especifique schemaName, tableName, columnName, maskingFunction e especifique ruleState como desabilitado. No entanto, se a regra ainda não existir, a regra será criada com ruleState definido como habilitado, independentemente do valor fornecido de ruleState.

Nome Tipo Description
Disabled

string

Enabled

string