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 パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
business
|
path | True |
string |
データ製品を含むビジネスドメインの一意識別子 |
|
data
|
path | True |
string |
データ資産の一意識別子 |
|
data
|
path | True |
string |
データ資産を含むデータ製品の一意識別子 |
|
endpoint
|
path | True |
string (uri) |
|
|
rule
|
path | True |
string |
ルールの一意識別子 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| id | True |
string |
一意ルール識別子 |
| name | True |
string |
規則の記述名称 |
| status | True |
string |
現在の執行状況 |
| type | True |
string |
ルールタイプ分類 |
| businessDomain |
ビジネスドメイン参照 |
||
| createdAt |
string (date-time) |
このルールが作られたタイムスタンプ |
|
| createdBy |
string |
ルールの作成者のためのユーザー識別子 |
|
| dataAsset |
データ資産参照 |
||
| dataProduct |
データ製品参照 |
||
| description |
string |
ルール検証とビジネス目的の詳細な説明 |
|
| dimension |
string |
任意の事業次元または分類 |
|
| lastModifiedAt |
string (date-time) |
このルールが最後に修正されたタイムスタンプ |
|
| lastModifiedBy |
string |
ルールの最後の修飾子のユーザー識別子 |
|
| score |
number (double) |
クオリティスコア(0.0から1.0) |
|
| typeProperties |
型固有の構成特性 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 201 Created |
要求が成功し、結果として新しいリソースが作成されました。 |
|
| Other Status Codes |
予期しないエラー応答。 ヘッダー x-ms-error-code: string |
セキュリティ
OAuth2Auth
型:
oauth2
フロー:
implicit
Authorization URL (承認 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. |
エラー オブジェクト。 |
|
Azure. |
エラーの詳細を含む応答。 |
|
Azure. |
エラーに関するより具体的な情報を含むオブジェクト。 Azure REST API のガイドラインに従って、https://aka.ms/AzureRestApiGuidelines#handling-errors。 |
| Column |
データセットの検証および品質チェックのための列定義 |
| Reference |
関係確立のためのデータガバナンス階層内のエンティティへの言及 |
|
Rule |
検証ロジック、実行パラメータ、スコアリングを備えたデータ品質ルールエンティティ |
|
Type |
データ品質ルールのタイプ固有の構成プロパティ。 |
Azure.Core.Foundations.Error
エラー オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
| details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
| message |
string |
エラーの人間が判読できる表現。 |
| target |
string |
エラーのターゲット。 |
Azure.Core.Foundations.ErrorResponse
エラーの詳細を含む応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
Azure.Core.Foundations.InnerError
エラーに関するより具体的な情報を含むオブジェクト。 Azure REST API のガイドラインに従って、https://aka.ms/AzureRestApiGuidelines#handling-errors。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
| innererror |
内部エラー。 |
Column
データセットの検証および品質チェックのための列定義
| 名前 | 型 | 説明 |
|---|---|---|
| type |
string |
列データタイプまたは分類 |
| value |
string |
列名または識別子 |
Reference
関係確立のためのデータガバナンス階層内のエンティティへの言及
| 名前 | 型 | 説明 |
|---|---|---|
| referenceId |
string |
参照対象エンティティの一意識別子 |
| type |
string |
参照対象エンティティのタイプ分類 |
RuleEntity
検証ロジック、実行パラメータ、スコアリングを備えたデータ品質ルールエンティティ
| 名前 | 型 | 説明 |
|---|---|---|
| businessDomain |
ビジネスドメイン参照 |
|
| createdAt |
string (date-time) |
このルールが作られたタイムスタンプ |
| createdBy |
string |
ルールの作成者のためのユーザー識別子 |
| dataAsset |
データ資産参照 |
|
| dataProduct |
データ製品参照 |
|
| 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
データ品質ルールのタイプ固有の構成プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| column |
列固有のルールのための列仕様。 |
|
| columns |
Column[] |
多列ルールやリレーショナルルール(例:Duplicate、CustomTruth)の列一覧。 |
| condition |
string |
検証基準を定義する主要な論理条件または表現。 |
| emptyCriteria |
string |
フィールドや列が空とみなされる場合を定義する任意の条件。 |
| filterCriteria |
string |
このルールで検証される行を制限するためのオプションのフィルター条件。 |
| pattern |
string |
フォーマットルールの正則表現またはパターンベースの検証ロジック。 |