Create Rules - Create Rules

Serviço:: Purview

Versão da API:: 2026-01-12-preview

Cria regras para um ativo de dados específico dentro de um produto de dados e domínio de negócio.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
businessDomainId	path	True	string	Identificador único para o domínio empresarial que contém o produto de dados
dataAssetId	path	True	string	Identificador único para o ativo de dados
dataProductId	path	True	string	Identificador único para o produto de dados que contém o ativo de dados
endpoint	path	True	string (uri)
ruleId	path	True	string	Identificador único para a regra
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
id	True	string	Identificador único de regra
name	True	string	Nome descritivo da regra
status	True	string	Estado atual da execução
type	True	string	Classificação dos tipos de regras
businessDomain		Reference	Referência do domínio empresarial
createdAt		string (date-time)	Carimbo temporal em que esta regra foi criada
createdBy		string	Identificador de utilizador do criador da regra
dataAsset		Reference	Referência de ativos de dados
dataProduct		Reference	Referência de produto de dados
description		string	Descrição detalhada da validação das regras e do propósito do negócio
dimension		string	Dimensão ou classificação opcional do negócio
lastModifiedAt		string (date-time)	Carimbo temporal em que esta regra foi modificada pela última vez
lastModifiedBy		string	Identificador de utilizador para o último modificador da regra
score		number (double)	Pontuação de qualidade (0.0 a 1.0)
typeProperties		TypeProperties	Propriedades de configuração específicas do tipo

Respostas

Name	Tipo	Description
201 Created	RuleEntity	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

201 Created

RuleEntity

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

OAuth2Auth

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

Âmbitos

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

Exemplos

CreateRules_DataAsset

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 201

{
  "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"
}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Column	Definição de coluna para validação de conjuntos de dados e verificações de qualidade
Reference	Referência a entidades na hierarquia de governação de dados para estabelecimento de relações
RuleEntity	Entidade de regra de qualidade de dados com lógica de validação, parâmetros de execução e pontuação
TypeProperties	Propriedades de configuração específicas por tipo para regras de qualidade de dados.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

Column

Object

Definição de coluna para validação de conjuntos de dados e verificações de qualidade

Name	Tipo	Description
type	string	Tipo de dados ou classificação da coluna
value	string	Nome ou identificador da coluna

Reference

Object

Referência a entidades na hierarquia de governação de dados para estabelecimento de relações

Name	Tipo	Description
referenceId	string	Identificador único da entidade referenciada
type	string	Classificação por tipo da entidade referenciada

RuleEntity

Object

Entidade de regra de qualidade de dados com lógica de validação, parâmetros de execução e pontuação

Name	Tipo	Description
businessDomain	Reference	Referência do domínio empresarial
createdAt	string (date-time)	Carimbo temporal em que esta regra foi criada
createdBy	string	Identificador de utilizador do criador da regra
dataAsset	Reference	Referência de ativos de dados
dataProduct	Reference	Referência de produto de dados
description	string	Descrição detalhada da validação das regras e do propósito do negócio
dimension	string	Dimensão ou classificação opcional do negócio
id	string	Identificador único de regra
lastModifiedAt	string (date-time)	Carimbo temporal em que esta regra foi modificada pela última vez
lastModifiedBy	string	Identificador de utilizador para o último modificador da regra
name	string	Nome descritivo da regra
score	number (double)	Pontuação de qualidade (0.0 a 1.0)
status	string	Estado atual da execução
type	string	Classificação dos tipos de regras
typeProperties	TypeProperties	Propriedades de configuração específicas do tipo

TypeProperties

Object

Propriedades de configuração específicas por tipo para regras de qualidade de dados.

Name	Tipo	Description
column	Column	Especificação de coluna para regras específicas de coluna.
columns	Column[]	Lista de colunas para regras de múltiplas colunas ou relacionais (por exemplo, Duplicate, CustomTruth).
condition	string	Principal critério lógico que define a condição lógica ou expressão de validação.
emptyCriteria	string	Condição opcional que define quando um campo ou coluna é considerado vazio.
filterCriteria	string	Condição opcional de filtro para limitar linhas validadas por esta regra.
pattern	string	Lógica de validação regex ou baseada em padrões para regras de formato.

Partilhar via

Create Rules - Create Rules

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

OAuth2Auth

Âmbitos

Exemplos

CreateRules_DataAsset

Pedido de amostra

Resposta da amostra

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Column

Reference

RuleEntity

TypeProperties