Data Masking Rules - List By Database

Referência

Service:: SQL Database

API Version:: 2021-11-01

Obtém uma lista de regras de mascaramento de dados de banco de dados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default/rules?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 regra 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 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.

Respostas

Nome	Tipo	Description
200 OK	DataMaskingRuleListResult	Recuperou com êxito a lista dos estados de Proteção Avançada contra Ameaças do servidor.
Other Status Codes		Respostas de erro: ***

Exemplos

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=2021-11-01


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.DataMaskingPolicyName;

/** Samples for DataMaskingRules ListByDatabase. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DataMaskingRuleListByDatabase.json
     */
    /**
     * Sample code: Gets a list of database data masking rules.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsAListOfDatabaseDataMaskingRules(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDataMaskingRules().listByDatabase("sqlcrudtest-6852",
            "sqlcrudtest-2080", "sqlcrudtest-331", DataMaskingPolicyName.DEFAULT, Context.NONE);
    }
}

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

Sample Response

Status code:: 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

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 regra de mascaramento de dados se aplica.
DataMaskingRule	Uma regra de mascaramento de dados de banco de dados.
DataMaskingRuleListResult	A lista de regras 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 regra 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 no 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 desmascarados 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ã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, 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 desmascarados no final da cadeia de caracteres. Caso contrário, esse parâmetro será ignorado.
properties.tableName	string	O nome da tabela no qual a regra de mascaramento de dados é aplicada.
type	string	Tipo de recurso.

DataMaskingRuleListResult

A lista de regras de mascaramento de dados de banco de dados.

Nome	Tipo	Description
nextLink	string	Link para recuperar a próxima página de resultados.
value	DataMaskingRule[]	Matriz de resultados.

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