Поделиться через


Create Rules - Create Rules

Создаёт правила для конкретного актива данных внутри продукта и бизнес-домена.

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

Параметры URI

Имя В Обязательно Тип Описание
businessDomainId
path True

string

Уникальный идентификатор бизнес-домена, содержащего продукт данных

dataAssetId
path True

string

Уникальный идентификатор для актива данных

dataProductId
path True

string

Уникальный идентификатор для произведения данных, содержащего этот актив

endpoint
path True

string (uri)

ruleId
path True

string

Уникальный идентификатор правила

api-version
query True

string

minLength: 1

Версия API, используемая для данной операции.

Текст запроса

Имя Обязательно Тип Описание
id True

string

Уникальный идентификатор правила

name True

string

Описательное название правила

status True

string

Текущий статус исполнения

type True

string

Классификация типов правил

businessDomain

Reference

Ссылка на бизнес-домен

createdAt

string (date-time)

Временная метка, когда было создано это правило

createdBy

string

Идентификатор пользователя для создателя правила

dataAsset

Reference

Ссылка на активы данных

dataProduct

Reference

Справочник по продукту данных

description

string

Подробное описание валидации правил и бизнес-цели

dimension

string

Необязательное бизнес-измерение или классификация

lastModifiedAt

string (date-time)

Временная метка, когда это правило было изменено в последний раз

lastModifiedBy

string

Идентификатор пользователя для последнего модификатора правила

score

number (double)

Оценка качества (от 0,0 до 1,0)

typeProperties

TypeProperties

Типоспецифические конфигурационные свойства

Ответы

Имя Тип Описание
201 Created

RuleEntity

Запрос успешно выполнен, и в результате был создан новый ресурс.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://purview.azure.net/.default

Примеры

CreateRules_DataAsset

Образец запроса

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

Пример ответа

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

Определения

Имя Описание
Azure.Core.Foundations.Error

Объект ошибки.

Azure.Core.Foundations.ErrorResponse

Ответ, содержащий сведения об ошибке.

Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по REST API Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Column

Определение столбцов для проверки и проверки качества наборов данных

Reference

Ссылка на сущности в иерархии управления данными для установления отношений

RuleEntity

Сущность правила качества данных с логикой валидации, параметрами выполнения и оценкой

TypeProperties

Тип-специфические свойства конфигурации правил качества данных.

Azure.Core.Foundations.Error

Объект ошибки.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.

details

Azure.Core.Foundations.Error[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.

innererror

Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

message

string

Читаемое пользователем представление ошибки.

target

string

Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Ответ, содержащий сведения об ошибке.

Имя Тип Описание
error

Azure.Core.Foundations.Error

Объект ошибки.

Azure.Core.Foundations.InnerError

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по REST API Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.

innererror

Azure.Core.Foundations.InnerError

Внутренняя ошибка.

Column

Определение столбцов для проверки и проверки качества наборов данных

Имя Тип Описание
type

string

Тип или классификация столбцов данных

value

string

Название колонки или идентификатор

Reference

Ссылка на сущности в иерархии управления данными для установления отношений

Имя Тип Описание
referenceId

string

Уникальный идентификатор связанной сущности

type

string

Классификация типов указанной сущности

RuleEntity

Сущность правила качества данных с логикой валидации, параметрами выполнения и оценкой

Имя Тип Описание
businessDomain

Reference

Ссылка на бизнес-домен

createdAt

string (date-time)

Временная метка, когда было создано это правило

createdBy

string

Идентификатор пользователя для создателя правила

dataAsset

Reference

Ссылка на активы данных

dataProduct

Reference

Справочник по продукту данных

description

string

Подробное описание валидации правил и бизнес-цели

dimension

string

Необязательное бизнес-измерение или классификация

id

string

Уникальный идентификатор правила

lastModifiedAt

string (date-time)

Временная метка, когда это правило было изменено в последний раз

lastModifiedBy

string

Идентификатор пользователя для последнего модификатора правила

name

string

Описательное название правила

score

number (double)

Оценка качества (от 0,0 до 1,0)

status

string

Текущий статус исполнения

type

string

Классификация типов правил

typeProperties

TypeProperties

Типоспецифические конфигурационные свойства

TypeProperties

Тип-специфические свойства конфигурации правил качества данных.

Имя Тип Описание
column

Column

Спецификация столбцов для правил, специфичных для столбцов.

columns

Column[]

Список столбцов для многостолбцевых или реляционных правил (например, Duplicate, CustomTruth).

condition

string

Основное логическое условие или выражение, определяющее критерии валидации.

emptyCriteria

string

Необязательное условие, определяющее, когда поле или столбец считается пустым.

filterCriteria

string

Опциональное условие фильтра, ограничивающее строки, валидируемые этим правилом.

pattern

string

Regex или логика валидации на основе шаблонов для правил форматирования.