Create Rules - Create Rules

Service:: Purview

Version d'API:: 2026-01-12-preview

Crée des règles pour un actif de données spécifique au sein d’un produit de données et d’un domaine métier.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
businessDomainId	path	True	string	Identifiant unique pour le domaine métier contenant le produit de données
dataAssetId	path	True	string	Identifiant unique pour l’actif de données
dataProductId	path	True	string	Identifiant unique pour le produit de données contenant l’actif de données
endpoint	path	True	string (uri)
ruleId	path	True	string	Identifiant unique pour la règle
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
id	True	string	Identifiant unique de règle
name	True	string	Nom descriptif de la règle
status	True	string	Statut actuel de l’exécution
type	True	string	Classification des types de règles
businessDomain		Reference	Référence du domaine métier
createdAt		string (date-time)	Horodatage de la création de cette règle
createdBy		string	Identifiant utilisateur du créateur de la règle
dataAsset		Reference	Référence d’actifs de données
dataProduct		Reference	Référence produit de données
description		string	Description détaillée de la validation des règles et de l’objectif commercial
dimension		string	Dimension ou classification optionnelle de l’entreprise
lastModifiedAt		string (date-time)	Horodatage de la dernière modification de cette règle
lastModifiedBy		string	Identifiant utilisateur pour le dernier modificateur de la règle
score		number (double)	Score qualité (0,0 à 1,0)
typeProperties		TypeProperties	Propriétés de configuration spécifiques à chaque type

Réponses

Nom	Type	Description
201 Created	RuleEntity	La requête a réussi et une nouvelle ressource a été créée en conséquence.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

201 Created

RuleEntity

La requête a réussi et une nouvelle ressource a été créée en conséquence.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

CreateRules_DataAsset

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API REST Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Column	Définition de colonne pour la validation et les contrôles de qualité des ensembles de données
Reference	Référence aux entités dans la hiérarchie de gouvernance des données pour l’établissement de relations
RuleEntity	Entité de règle de qualité des données avec logique de validation, paramètres d’exécution et score
TypeProperties	Propriétés de configuration spécifiques au type pour les règles de qualité des données.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Une représentation lisible par une personne de l'erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API REST Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

Column

Objet

Définition de colonne pour la validation et les contrôles de qualité des ensembles de données

Nom	Type	Description
type	string	Type de données ou classification de colonne
value	string	Nom ou identifiant de colonne

Reference

Objet

Référence aux entités dans la hiérarchie de gouvernance des données pour l’établissement de relations

Nom	Type	Description
referenceId	string	Identifiant unique de l’entité référencée
type	string	Classification de type de l’entité référencée

RuleEntity

Objet

Entité de règle de qualité des données avec logique de validation, paramètres d’exécution et score

Nom	Type	Description
businessDomain	Reference	Référence du domaine métier
createdAt	string (date-time)	Horodatage de la création de cette règle
createdBy	string	Identifiant utilisateur du créateur de la règle
dataAsset	Reference	Référence d’actifs de données
dataProduct	Reference	Référence produit de données
description	string	Description détaillée de la validation des règles et de l’objectif commercial
dimension	string	Dimension ou classification optionnelle de l’entreprise
id	string	Identifiant unique de règle
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de cette règle
lastModifiedBy	string	Identifiant utilisateur pour le dernier modificateur de la règle
name	string	Nom descriptif de la règle
score	number (double)	Score qualité (0,0 à 1,0)
status	string	Statut actuel de l’exécution
type	string	Classification des types de règles
typeProperties	TypeProperties	Propriétés de configuration spécifiques à chaque type

TypeProperties

Objet

Propriétés de configuration spécifiques au type pour les règles de qualité des données.

Nom	Type	Description
column	Column	Spécification de colonne pour les règles spécifiques à chaque colonne.
columns	Column[]	Liste des colonnes pour les règles multi-colonnes ou relationnelles (par exemple, Duplique, CustomTruth).
condition	string	Critères principaux de validation définissant la condition logique ou l’expression.
emptyCriteria	string	Condition optionnelle définissant quand un champ ou une colonne est considéré comme vide.
filterCriteria	string	Condition de filtre optionnelle pour limiter les lignes validées par cette règle.
pattern	string	Logique de validation régex ou basée sur des motifs pour les règles de format.

Partager via

Create Rules - Create Rules

Paramètres URI

Corps de la demande

Réponses

Sécurité

OAuth2Auth

Étendues

Exemples

CreateRules_DataAsset

Exemple de requête

Exemple de réponse

Définitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Column

Reference

RuleEntity

TypeProperties