Create Rules - Create Rules

Tjänst:: Purview

API-version:: 2026-01-12-preview

Skapar regler för en specifik datatillgång inom en dataprodukt och affärsdomän.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
businessDomainId	path	True	string	Unik identifierare för affärsdomänen som innehåller dataprodukten
dataAssetId	path	True	string	Unik identifierare för datatillgången
dataProductId	path	True	string	Unik identifierare för dataprodukten som innehåller datatillgången
endpoint	path	True	string (uri)
ruleId	path	True	string	Unik identifierare för regeln
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
id	True	string	Unik regelidentifierare
name	True	string	Beskrivande namn på regeln
status	True	string	Nuvarande exekutionsstatus
type	True	string	Regeltypklassificering
businessDomain		Reference	Affärsdomänreferens
createdAt		string (date-time)	Tidsstämpel när denna regel skapades
createdBy		string	Användaridentifierare för skaparen av regeln
dataAsset		Reference	Datatillgångsreferens
dataProduct		Reference	Dataproduktreferens
description		string	Detaljerad beskrivning av regelvalidering och affärssyfte
dimension		string	Valfri affärsdimension eller klassificering
lastModifiedAt		string (date-time)	Tidsstämpel när denna regel senast ändrades
lastModifiedBy		string	Användaridentifierare för den sista modifieraren av regeln
score		number (double)	Kvalitetspoäng (0,0 till 1,0)
typeProperties		TypeProperties	Typspecifika konfigurationsegenskaper

Svar

Name	Typ	Description
201 Created	RuleEntity	Begäran har slutförts och en ny resurs har skapats som ett resultat.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

201 Created

RuleEntity

Begäran har slutförts och en ny resurs har skapats som ett resultat.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

CreateRules_DataAsset

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Azure riktlinjer för REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.
Column	Kolumndefinition för validering och kvalitetskontroller av datamängder
Reference	Referens till enheter i datastyrningshierarkin för relationsetablering
RuleEntity	Datakvalitetsregelenhet med valideringslogik, exekveringsparametrar och poängsättning
TypeProperties	Typspecifika konfigurationsegenskaper för datakvalitetsregler.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Azure riktlinjer för REST API – https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

Column

Objekt

Kolumndefinition för validering och kvalitetskontroller av datamängder

Name	Typ	Description
type	string	Kolumndatatyp eller klassificering
value	string	Kolumnnamn eller identifierare

Reference

Objekt

Referens till enheter i datastyrningshierarkin för relationsetablering

Name	Typ	Description
referenceId	string	Unik identifierare för den refererade enheten
type	string	Typklassificering av den refererade enheten

RuleEntity

Objekt

Datakvalitetsregelenhet med valideringslogik, exekveringsparametrar och poängsättning

Name	Typ	Description
businessDomain	Reference	Affärsdomänreferens
createdAt	string (date-time)	Tidsstämpel när denna regel skapades
createdBy	string	Användaridentifierare för skaparen av regeln
dataAsset	Reference	Datatillgångsreferens
dataProduct	Reference	Dataproduktreferens
description	string	Detaljerad beskrivning av regelvalidering och affärssyfte
dimension	string	Valfri affärsdimension eller klassificering
id	string	Unik regelidentifierare
lastModifiedAt	string (date-time)	Tidsstämpel när denna regel senast ändrades
lastModifiedBy	string	Användaridentifierare för den sista modifieraren av regeln
name	string	Beskrivande namn på regeln
score	number (double)	Kvalitetspoäng (0,0 till 1,0)
status	string	Nuvarande exekutionsstatus
type	string	Regeltypklassificering
typeProperties	TypeProperties	Typspecifika konfigurationsegenskaper

TypeProperties

Objekt

Typspecifika konfigurationsegenskaper för datakvalitetsregler.

Name	Typ	Description
column	Column	Kolumnspecifikation för kolumnspecifika regler.
columns	Column[]	Lista över kolumner för flerkolumns- eller relationsregler (t.ex. Duplicate, CustomTruth).
condition	string	Huvudsakligt logiskt villkor eller uttryck som definierar valideringskriterier.
emptyCriteria	string	Valfritt villkor som definierar när ett fält eller en kolumn anses vara tom.
filterCriteria	string	Valfritt filtervillkor för att begränsa rader som valideras av denna regel.
pattern	string	Regex eller mönsterbaserad valideringslogik för formatregler.

Dela via

Create Rules - Create Rules

URI-parametrar

Begärandetext

Svar

Säkerhet

OAuth2Auth

Omfattningar

Exempel

CreateRules_DataAsset

Exempelbegäran

Exempelsvar

Definitioner

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Column

Reference

RuleEntity

TypeProperties