Create Rules - Create Rules

Usługa:: Purview

Wersja interfejsu API:: 2026-01-12-preview

Tworzy reguły dla konkretnego zasobu danych w obrębie produktu i domeny biznesowej.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
businessDomainId	path	True	string	Unikalny identyfikator domeny biznesowej zawierającej produkt danych
dataAssetId	path	True	string	Unikalny identyfikator dla zasobu danych
dataProductId	path	True	string	Unikalny identyfikator produktu danych zawierającego zasób danych
endpoint	path	True	string (uri)
ruleId	path	True	string	Unikalny identyfikator reguły
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
id	True	string	Unikalny identyfikator reguły
name	True	string	Opisowa nazwa reguły
status	True	string	Aktualny status wykonania
type	True	string	Klasyfikacja typów reguł
businessDomain		Reference	Referencja domeny biznesowej
createdAt		string (date-time)	Znacznik czasu utworzenia tej reguły
createdBy		string	Identyfikator użytkownika twórcy reguły
dataAsset		Reference	Referencje zasobów danych
dataProduct		Reference	Referencja produktu danych
description		string	Szczegółowy opis walidacji reguł i celu biznesowego
dimension		string	Opcjonalny wymiar biznesowy lub klasyfikacja
lastModifiedAt		string (date-time)	Znacznik czasu ostatniej zmiany tej zasady
lastModifiedBy		string	Identyfikator użytkownika dla ostatniego modyfikatora reguły
score		number (double)	Ocena jakości (0,0 do 1,0)
typeProperties		TypeProperties	Specyficzne dla typu właściwości konfiguracyjne

Odpowiedzi

Nazwa	Typ	Opis
201 Created	RuleEntity	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

201 Created

RuleEntity

Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://purview.azure.net/.default

Przykłady

CreateRules_DataAsset

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API REST Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
Column	Definicja kolumn do walidacji zbiorów danych i kontroli jakości
Reference	Odniesienie do podmiotów w hierarchii zarządzania danymi dla ustanawiania relacji
RuleEntity	Encja reguły jakości danych z logiką walidacji, parametrami wykonania i punktacją
TypeProperties	Specyficzne dla typu właściwości konfiguracyjne dla reguł jakości danych.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API REST Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

Column

Objekt

Definicja kolumn do walidacji zbiorów danych i kontroli jakości

Nazwa	Typ	Opis
type	string	Typ lub klasyfikacja danych kolumn
value	string	Nazwa kolumny lub identyfikator

Reference

Objekt

Odniesienie do podmiotów w hierarchii zarządzania danymi dla ustanawiania relacji

Nazwa	Typ	Opis
referenceId	string	Unikalny identyfikator cytowanego podmiotu
type	string	Klasyfikacja typów podmiotu odniesienego

RuleEntity

Objekt

Encja reguły jakości danych z logiką walidacji, parametrami wykonania i punktacją

Nazwa	Typ	Opis
businessDomain	Reference	Referencja domeny biznesowej
createdAt	string (date-time)	Znacznik czasu utworzenia tej reguły
createdBy	string	Identyfikator użytkownika twórcy reguły
dataAsset	Reference	Referencje zasobów danych
dataProduct	Reference	Referencja produktu danych
description	string	Szczegółowy opis walidacji reguł i celu biznesowego
dimension	string	Opcjonalny wymiar biznesowy lub klasyfikacja
id	string	Unikalny identyfikator reguły
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej zmiany tej zasady
lastModifiedBy	string	Identyfikator użytkownika dla ostatniego modyfikatora reguły
name	string	Opisowa nazwa reguły
score	number (double)	Ocena jakości (0,0 do 1,0)
status	string	Aktualny status wykonania
type	string	Klasyfikacja typów reguł
typeProperties	TypeProperties	Specyficzne dla typu właściwości konfiguracyjne

TypeProperties

Objekt

Specyficzne dla typu właściwości konfiguracyjne dla reguł jakości danych.

Nazwa	Typ	Opis
column	Column	Specyfikacja kolumn dla reguł specyficznych dla kolumn.
columns	Column[]	Lista kolumn dla reguł wielokolumnowych lub relacyjnych (np. Duplicate, CustomTruth).
condition	string	Główny warunek logiczny lub wyrażenie definiujące kryteria walidacji.
emptyCriteria	string	Opcjonalny warunek określający, kiedy pole lub kolumna jest uważana za pustą.
filterCriteria	string	Opcjonalny warunek filtra ograniczający wiersze walidowane przez tę regułę.
pattern	string	Regex lub logika walidacji oparta na wzorcach dla reguł formatu.

Udostępnij za pośrednictwem

Create Rules - Create Rules

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

OAuth2Auth

Zakresy

Przykłady

CreateRules_DataAsset

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Column

Reference

RuleEntity

TypeProperties