Data Masking Rules - List By Database

Servicio:: SQL Database

Versión de la API:: 2023-08-01

Obtiene una lista de reglas de enmascaramiento de datos de base de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	Nombre de la base de datos.
dataMaskingPolicyName	path	True	DataMaskingPolicyName	Nombre de la base de datos para la que se aplica la regla de enmascaramiento de datos.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName	path	True	string	Nombre del servidor.
subscriptionId	path	True	string	Identificador de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	Versión de la API que se va a usar para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	DataMaskingRuleListResult	Recuperó correctamente la lista de estados de Advanced Threat Protection del servidor.
Other Status Codes	ErrorResponse	Respuestas de error: ***

Ejemplos

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=2023-08-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/stable/2023-08-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://dori-uw-1.kuma-moon.com/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

Respuesta de muestra

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
      }
    }
  ]
}

Definiciones

Nombre	Description
DataMaskingFunction	Función de enmascaramiento que se usa para la regla de enmascaramiento de datos.
DataMaskingPolicyName	Nombre de la base de datos para la que se aplica la regla de enmascaramiento de datos.
DataMaskingRule	Una regla de enmascaramiento de datos de base de datos.
DataMaskingRuleListResult	Lista de reglas de enmascaramiento de datos de base de datos.
DataMaskingRuleState	El estado de la regla. Se usa para eliminar una regla. Para eliminar una regla existente, especifique schemaName, tableName, columnName, maskingFunction y especifique ruleState como deshabilitado. Sin embargo, si la regla aún no existe, la regla se creará con ruleState establecido en habilitado, independientemente del valor proporcionado de ruleState.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

DataMaskingFunction

Enumeración

Función de enmascaramiento que se usa para la regla de enmascaramiento de datos.

Valor	Description
Default
CCN
Email
Number
SSN
Text

DataMaskingPolicyName

Enumeración

Nombre de la base de datos para la que se aplica la regla de enmascaramiento de datos.

Valor	Description
Default

DataMaskingRule

Object

Una regla de enmascaramiento de datos de base de datos.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	El tipo de regla de enmascaramiento de datos. Metadatos, usados para Azure Portal.
location	string	Ubicación de la regla de enmascaramiento de datos.
name	string	Nombre del recurso.
properties.aliasName	string	Nombre del alias. Se trata de un parámetro heredado y ya no se usa.
properties.columnName	string	Nombre de columna en el que se aplica la regla de enmascaramiento de datos.
properties.id	string	Identificador de regla.
properties.maskingFunction	DataMaskingFunction	Función de enmascaramiento que se usa para la regla de enmascaramiento de datos.
properties.numberFrom	string	La propiedad numberFrom de la regla de enmascaramiento. Obligatorio si maskingFunction se establece en Number; de lo contrario, se omitirá este parámetro.
properties.numberTo	string	La propiedad numberTo de la regla de enmascaramiento de datos. Obligatorio si maskingFunction se establece en Number; de lo contrario, se omitirá este parámetro.
properties.prefixSize	string	Si maskingFunction se establece en Text, el número de caracteres que se mostrará sin máscara al principio de la cadena. De lo contrario, este parámetro se omitirá.
properties.replacementString	string	Si maskingFunction se establece en Text, el carácter que se usará para enmascarar la parte no expuesta de la cadena. De lo contrario, este parámetro se omitirá.
properties.ruleState	DataMaskingRuleState	El estado de la regla. Se usa para eliminar una regla. Para eliminar una regla existente, especifique schemaName, tableName, columnName, maskingFunction y especifique ruleState como deshabilitado. Sin embargo, si la regla aún no existe, la regla se creará con ruleState establecido en habilitado, independientemente del valor proporcionado de ruleState.
properties.schemaName	string	Nombre de esquema en el que se aplica la regla de enmascaramiento de datos.
properties.suffixSize	string	Si maskingFunction se establece en Text, el número de caracteres que se mostrarán sin máscara al final de la cadena. De lo contrario, este parámetro se omitirá.
properties.tableName	string	Nombre de tabla en el que se aplica la regla de enmascaramiento de datos.
type	string	Tipo de recurso.

DataMaskingRuleListResult

Object

Lista de reglas de enmascaramiento de datos de base de datos.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la siguiente página de resultados.
value	DataMaskingRule[]	Matriz de resultados.

DataMaskingRuleState

Enumeración

El estado de la regla. Se usa para eliminar una regla. Para eliminar una regla existente, especifique schemaName, tableName, columnName, maskingFunction y especifique ruleState como deshabilitado. Sin embargo, si la regla aún no existe, la regla se creará con ruleState establecido en habilitado, independientemente del valor proporcionado de ruleState.

Valor	Description
Enabled
Disabled

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Compartir a través de

Data Masking Rules - List By Database

Parámetros de identificador URI

Respuestas

Ejemplos

Gets a list of database data masking rules.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DataMaskingFunction

DataMaskingPolicyName

DataMaskingRule

DataMaskingRuleListResult

DataMaskingRuleState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse