Data Masking Rules - Create Or Update

Servicio:
SQL Database
Versión de la API:
2025-01-01

Crea o actualiza una regla de enmascaramiento de datos de base de datos.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
databaseName
 path True

string

El nombre de la base de datos.
dataMaskingPolicyName
 path True

DataMaskingPolicyName

El nombre de la base de datos para la que se aplica la política de enmascaramiento de datos.
dataMaskingRuleName
 path True

string

El nombre de la regla de enmascaramiento de datos.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName
 path True

string

El nombre del servidor.
subscriptionId
 path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version
 query True

string

minLength: 1

Versión de API que se usará para esta operación.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
properties.columnName True

string

Nombre de columna en el que se aplica la regla de enmascaramiento de datos.
properties.maskingFunction True

DataMaskingFunction

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

string

Nombre de esquema en el que se aplica la regla de enmascaramiento de datos.
properties.tableName True

string

Nombre de tabla en el que se aplica la regla de enmascaramiento de datos.
properties.aliasName

string

Nombre del alias. Se trata de un parámetro heredado y ya no se usa.
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.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á.

Respuestas

Nombre Tipo Description
200 OK

DataMaskingRule

Operación de Azure completada con éxito.
201 Created

DataMaskingRule

Recurso 'DataMaskingRule' crear operación exitosa
Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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.

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
200 
{
  "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": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
status code:
201 
{
  "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": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for default min.

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
200 
{
  "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": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
status code:
201 
{
  "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": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for numbers.

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
200 
{
  "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"
  }
}
status code:
201 
{
  "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"
  }
}

Create/Update data masking rule for text.

Solicitud de ejemplo

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

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

Respuesta de muestra

status code:
200 
{
  "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"
  }
}
status code:
201 
{
  "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"
  }
}

Definiciones

Nombre Description
createdByType

Tipo de identidad que creó el recurso.
DataMaskingFunction

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

Una regla de enmascaramiento de datos de bases 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
systemData

Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor Description
User
Application
ManagedIdentity
Key

DataMaskingFunction

Enumeración

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

Valor Description
Default

Predeterminado
CCN

CCN
Email

Correo electrónico
Number

Número
SSN

SSN
Text

Text

DataMaskingPolicyName

Enumeración
Valor Description
Default

Predeterminado

DataMaskingRule

Objeto

Una regla de enmascaramiento de datos de bases de datos.

Nombre Tipo Description
id

string (arm-id)

Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

string

El tipo de Regla de Enmascaramiento de Datos. Metadatos, usados para el portal Azure.
location

string

La 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

La regla Id.
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.
systemData

systemData

Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
type

string

Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

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

Habilitado
Disabled

Deshabilitado

ErrorAdditionalInfo

Objeto

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

Objeto

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

El mensaje de error.
target

string

Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo de creación de recursos (UTC).
createdBy

string

Identidad que creó el recurso.
createdByType

createdByType

Tipo de identidad que creó el recurso.
lastModifiedAt

string (date-time)

La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy

string

Identidad que modificó por última vez el recurso.
lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.