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 política de mascaramento de dados.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	DataMaskingRuleListResult	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

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

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/SQL/stable/2025-01-01/examples/DataMaskingRuleListByDatabase.json
// this example is just showing the usage of "DataMaskingRules_List" 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://dotnet.territoriali.olinfo.it/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 and iterate over the result
await foreach (DataMaskingRule item in dataMaskingPolicy.GetDataMaskingRulesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "name": null,
      "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
      "kind": null,
      "location": "Central US",
      "properties": {
        "aliasName": null,
        "columnName": "test1",
        "id": "dbo_Table_1_test1",
        "maskingFunction": "Text",
        "numberFrom": null,
        "numberTo": null,
        "prefixSize": "1",
        "replacementString": "asdf",
        "ruleState": "Enabled",
        "schemaName": "dbo",
        "suffixSize": "0",
        "tableName": "Table_1"
      }
    },
    {
      "name": null,
      "type": "Microsoft.Sql/servers/databases/dataMaskingPolicies/rules",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1",
      "kind": null,
      "location": "Central US",
      "properties": {
        "aliasName": null,
        "columnName": "test1",
        "id": "dbo_Table_1_test1",
        "maskingFunction": "Number",
        "numberFrom": "0",
        "numberTo": "2",
        "prefixSize": null,
        "replacementString": null,
        "ruleState": "Enabled",
        "schemaName": "dbo",
        "suffixSize": null,
        "tableName": "Table_1"
      }
    }
  ]
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
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 política de mascaramento de dados.
DataMaskingRule	Uma regra de mascaramento de dados de base de dados.
DataMaskingRuleListResult	A resposta de uma operação de lista DataMaskingRule.
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
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DataMaskingFunction

Enumeração

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

Valor	Description
Default	Predefinição
CCN	CCN
Email	Email
Number	Número
SSN	NSS
Text	Texto

DataMaskingPolicyName

Enumeração

O nome da base de dados para a qual se aplica a política de mascaramento de dados.

Valor	Description
Default	Predefinição

DataMaskingRule

Object

Uma regra de mascaramento de dados de base de dados.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
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	O 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.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

DataMaskingRuleListResult

Object

A resposta de uma operação de lista DataMaskingRule.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	DataMaskingRule[]	Os itens DataMaskingRule nesta página

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	Ativado
Disabled	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.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.