Compartir a través de


Create Rules - Create Rules

Crea reglas para un activo de datos específico dentro de un producto de datos y dominio empresarial.

PUT {endpoint}/purviewdataquality/api/business-domains/{businessDomainId}/data-products/{dataProductId}/data-assets/{dataAssetId}/rules/{ruleId}?api-version=2026-01-12-preview

Parámetros de identificador URI

Nombre En Requerido Tipo Description
businessDomainId
path True

string

Identificador único para el dominio empresarial que contiene el producto de datos

dataAssetId
path True

string

Identificador único para el activo de datos

dataProductId
path True

string

Identificador único para el producto de datos que contiene el activo de datos

endpoint
path True

string (uri)

ruleId
path True

string

Identificador único para la regla

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
id True

string

Identificador de regla único

name True

string

Nombre descriptivo de la regla

status True

string

Estado actual de la ejecución

type True

string

Clasificación por tipos de reglas

businessDomain

Reference

Referencia del dominio empresarial

createdAt

string (date-time)

Marca temporal en la que se creó esta regla

createdBy

string

Identificador de usuario del creador de la regla

dataAsset

Reference

Referencia de activos de datos

dataProduct

Reference

Referencia de producto de datos

description

string

Descripción detallada de la validación de reglas y el propósito empresarial

dimension

string

Dimensión o clasificación opcional del negocio

lastModifiedAt

string (date-time)

Marca temporal cuando se modificó esta regla por última vez

lastModifiedBy

string

Identificador de usuario para el último modificador de la regla

score

number (double)

Puntuación de calidad (0.0 a 1.0)

typeProperties

TypeProperties

Propiedades de configuración específicas de tipo

Respuestas

Nombre Tipo Description
201 Created

RuleEntity

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

OAuth2Auth

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

Ámbitos

Nombre Description
https://purview.azure.net/.default

Ejemplos

CreateRules_DataAsset

Solicitud de ejemplo

PUT {endpoint}/purviewdataquality/api/business-domains/abcdef12-3456-7890-abcd-ef1234567890/data-products/12345678-abcd-1234-ef00-123456abcdef/data-assets/abcd1234-5678-abcd-1234-abcd5678ef00/rules/rule-1234-5678-abcd-ef00-123456abcdef?api-version=2026-01-12-preview

{
  "id": "06dda07d-126b-43c1-aade-2484b265a271",
  "name": "Custom",
  "description": "",
  "type": "CustomTruth",
  "status": "Active",
  "typeProperties": {
    "condition": "{REVENUE} > 50000",
    "filterCriteria": "{REGION} == 'India'",
    "emptyCriteria": "{REVENUE_TARGET} < 100000",
    "columns": [
      {
        "value": "REVENUE",
        "type": "Column"
      },
      {
        "value": "REGION",
        "type": "Column"
      },
      {
        "value": "REVENUE_TARGET",
        "type": "Column"
      }
    ]
  },
  "dimension": "Accuracy",
  "businessDomain": {
    "referenceId": "76be16f9-5cb3-4839-83d6-4e3829a8ab0c",
    "type": "BusinessDomainReference"
  },
  "dataProduct": {
    "referenceId": "2a1d2087-09e2-4ecf-817d-1f5bfcbc31bf",
    "type": "DataProductReference"
  },
  "dataAsset": {
    "referenceId": "fadb55b6-aa10-47d5-82c4-5e2723ba7869",
    "type": "DataAssetReference"
  }
}

Respuesta de muestra

{
  "name": "Custom",
  "description": "",
  "type": "CustomTruth",
  "status": "Active",
  "typeProperties": {
    "condition": "{REVENUE} > 50000",
    "filterCriteria": "{REGION} == 'India'",
    "emptyCriteria": "{REVENUE_TARGET} < 100000",
    "columns": [
      {
        "value": "REVENUE",
        "type": "Column"
      },
      {
        "value": "REGION",
        "type": "Column"
      },
      {
        "value": "REVENUE_TARGET",
        "type": "Column"
      }
    ]
  },
  "dimension": "Accuracy",
  "id": "06dda07d-126b-43c1-aade-2484b265a271",
  "businessDomain": {
    "type": "BusinessDomainReference",
    "referenceId": "76be16f9-5cb3-4839-83d6-4e3829a8ab0c"
  },
  "dataProduct": {
    "type": "DataProductReference",
    "referenceId": "2a1d2087-09e2-4ecf-817d-1f5bfcbc31bf"
  },
  "dataAsset": {
    "type": "DataAssetReference",
    "referenceId": "fadb55b6-aa10-47d5-82c4-5e2723ba7869"
  },
  "score": -1,
  "createdAt": "2025-11-13T09:08:28.1798306Z",
  "lastModifiedAt": "2025-11-13T09:08:29.1508867Z",
  "createdBy": "6f19d772-4716-4523-9910-cb1575512ce6",
  "lastModifiedBy": "6f19d772-4716-4523-9910-cb1575512ce6"
}

Definiciones

Nombre Description
Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las instrucciones de la API rest de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Column

Definición de columna para validación de conjuntos de datos y controles de calidad

Reference

Referencia a entidades en la jerarquía de gobernanza de datos para el establecimiento de relaciones

RuleEntity

Entidad de regla de calidad de datos con lógica de validación, parámetros de ejecución y puntuación

TypeProperties

Propiedades de configuración específicas de tipo para reglas de calidad de datos.

Azure.Core.Foundations.Error

Objeto de error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.

details

Azure.Core.Foundations.Error[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.

innererror

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

message

string

Una representación en lenguaje natural del error.

target

string

Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre Tipo Description
error

Azure.Core.Foundations.Error

Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las instrucciones de la API rest de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.

innererror

Azure.Core.Foundations.InnerError

Error interno.

Column

Definición de columna para validación de conjuntos de datos y controles de calidad

Nombre Tipo Description
type

string

Tipo de dato de columna o clasificación

value

string

Nombre o identificador de columna

Reference

Referencia a entidades en la jerarquía de gobernanza de datos para el establecimiento de relaciones

Nombre Tipo Description
referenceId

string

Identificador único de la entidad referenciada

type

string

Clasificación de tipos de la entidad referenciada

RuleEntity

Entidad de regla de calidad de datos con lógica de validación, parámetros de ejecución y puntuación

Nombre Tipo Description
businessDomain

Reference

Referencia del dominio empresarial

createdAt

string (date-time)

Marca temporal en la que se creó esta regla

createdBy

string

Identificador de usuario del creador de la regla

dataAsset

Reference

Referencia de activos de datos

dataProduct

Reference

Referencia de producto de datos

description

string

Descripción detallada de la validación de reglas y el propósito empresarial

dimension

string

Dimensión o clasificación opcional del negocio

id

string

Identificador de regla único

lastModifiedAt

string (date-time)

Marca temporal cuando se modificó esta regla por última vez

lastModifiedBy

string

Identificador de usuario para el último modificador de la regla

name

string

Nombre descriptivo de la regla

score

number (double)

Puntuación de calidad (0.0 a 1.0)

status

string

Estado actual de la ejecución

type

string

Clasificación por tipos de reglas

typeProperties

TypeProperties

Propiedades de configuración específicas de tipo

TypeProperties

Propiedades de configuración específicas de tipo para reglas de calidad de datos.

Nombre Tipo Description
column

Column

Especificación de columna para reglas específicas de columna.

columns

Column[]

Lista de columnas para reglas de múltiples columnas o relacionales (por ejemplo, Duplicado, CustomTruth).

condition

string

Principal criterio lógico que define la validación de la condición lógica o la expresión.

emptyCriteria

string

Condición opcional que define cuándo un campo o columna se considera vacío.

filterCriteria

string

Condición opcional de filtro para limitar filas que se validan por esta regla.

pattern

string

Lógica de validación por regex o basada en patrones para reglas de formato.