Partilhar via

Data Masking Rules - List By Database

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

Obtém uma lista de regras de mascaramento de dados da base de dados.

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

Parâmetros do URI

Name Em Necessário Tipo Description
databaseName
 path True

string

O nome do banco de dados.
dataMaskingPolicyName
 path True

DataMaskingPolicyName

O nome da base de dados para a qual se aplica a 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 da API do Azure Resource Manager ou 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.

Respostas

Name Tipo Description
200 OK

DataMaskingRuleListResult

Recuperada com êxito a lista de estados de Proteção Avançada contra Ameaças do servidor.
Other Status Codes

ErrorResponse

Respostas de erro: ***

Exemplos

Gets a list of database data masking rules.

Pedido de amostra

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

Resposta da amostra

Código de estado:
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
      }
    }
  ]
}

Definições

Name Description
DataMaskingFunction

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

O nome da base de dados para a qual se aplica a regra de mascaramento de dados.
DataMaskingRule

Uma regra de mascaramento de dados de base de dados.
DataMaskingRuleListResult

A lista de regras de mascaramento de dados da base 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, ela será criada com ruleState definido como enabled, independentemente do valor fornecido de ruleState.
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro

DataMaskingFunction

Enumeração

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

Valor Description
Default
CCN
Email
Number
SSN
Text

DataMaskingPolicyName

Enumeração

O nome da base de dados para a qual se aplica a regra de mascaramento de dados.

Valor Description
Default

DataMaskingRule

Object

Uma regra de mascaramento de dados de base de dados.

Name Tipo Description
id

string

ID do recurso.
kind

string

O tipo de Regra de Mascaramento de Dados. Metadados, usados para o portal Azure.
location

string

A localização da regra de mascaramento de dados.
name

string

Nome do recurso.
properties.aliasName

string

O nome do alias. Este é 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 regra Id.
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 Number, 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 Number, caso contrário, esse parâmetro será ignorado.
properties.prefixSize

string

Se maskingFunction estiver definido como Text, o número de caracteres a serem exibidos desmascarados no início da cadeia de caracteres. Caso contrário, esse parâmetro será ignorado.
properties.replacementString

string

Se maskingFunction estiver definido como Text, o caractere a ser usado para mascarar a parte não exposta 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, ela será criada com ruleState definido como enabled, 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 Text, o número de caracteres a serem exibidos desmascarados 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.

DataMaskingRuleListResult

Object

A lista de regras de mascaramento de dados da base de dados.

Name Tipo Description
nextLink

string

Link para recuperar a próxima página de resultados.
value

DataMaskingRule[]

Matriz de resultados.

DataMaskingRuleState

Enumeração

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, ela será criada com ruleState definido como enabled, independentemente do valor fornecido de ruleState.

Valor Description
Enabled
Disabled

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.