Items - Update KQL Queryset Definition
指定した KQL クエリセットの定義をオーバーライドします。
この API は、実行時間の長い操作 (LRO)をサポートします。
権限
呼び出し元には、KQL クエリセットの 読み取りと書き込みの アクセス許可が必要です。
必要な委任されたスコープ
KQLQueryset.ReadWrite.All または Item.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
アイデンティティ | 支援 |
---|---|
ユーザー | イエス |
サービス プリンシパルとマネージド ID | イエス |
インターフェイス
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/updateDefinition
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlQuerysets/{kqlQuerysetId}/updateDefinition?updateMetadata={updateMetadata}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
kql
|
path | True |
string (uuid) |
KQL クエリセット ID。 |
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
update
|
query |
boolean |
true に設定され、.platform ファイルが定義の一部として提供されると、.platform ファイル内のメタデータを使用して項目のメタデータが更新されます。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
definition | True |
KQL クエリセットのパブリック定義オブジェクト。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は正常に完了しました。 |
|
202 Accepted |
要求は受け入れ済み。 更新の定義が進行中です。 ヘッダー
|
|
Other Status Codes |
一般的なエラー コード:
|
例
Update a KQL queryset definition example
要求のサンプル
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlQuerysets/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True
{
"definition": {
"parts": [
{
"path": "RealTimeQueryset.json",
"payload": "ewogICAgInF1ZXJ5c2V0IjogewogICAgICAgICJ2ZXJzaW9uIjogIjEuMC4wIiwKICAgICAgICAiZGF0YVNvdXJjZXMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImMyNDM0YmY4LTI1YmItNGFhMC04NzQ2LWRiNDcwNTMzYWRhZiIsCiAgICAgICAgICAgICAgICAiY2x1c3RlclVyaSI6ICJodHRwczovL2hlbHAua3VzdG8ud2luZG93cy5uZXQvIiwKICAgICAgICAgICAgICAgICJ0eXBlIjogIkF6dXJlRGF0YUV4cGxvcmVyIiwKICAgICAgICAgICAgICAgICJkYXRhYmFzZU5hbWUiOiAiU2FtcGxlcyIKICAgICAgICAgICAgfQogICAgICAgIF0sCiAgICAgICAgInRhYnMiOiBbewogICAgICAgICAgICAgICAgImlkIjogImNjZDdiOTBjLTUxZmUtNDI5Zi1hODUzLTM4NWIwMmJkNzRjOSIsCiAgICAgICAgICAgICAgICAiY29udGVudCI6ICJTdG9ybUV2ZW50c1xcXFxufCBjb3VudCIsCiAgICAgICAgICAgICAgICAidGl0bGUiOiAiVGFiMU5hbWUiLAogICAgICAgICAgICAgICAgImRhdGFTb3VyY2VJZCI6ICJjMjQzNGJmOC0yNWJiLTRhYTAtODc0Ni1kYjQ3MDUzM2FkYWYiCiAgICAgICAgICAgIH0KICAgICAgICBdCiAgICB9Cn0=",
"payloadType": "InlineBase64"
},
{
"path": ".platform",
"payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
"payloadType": "InlineBase64"
}
]
}
}
応答のサンプル
定義
名前 | 説明 |
---|---|
Error |
エラー関連のリソース詳細オブジェクト。 |
Error |
エラー応答。 |
Error |
エラー応答の詳細。 |
KQLQueryset |
KQL クエリセットのパブリック定義オブジェクト。 |
KQLQueryset |
KQL クエリセット定義パーツ オブジェクト。 |
Payload |
定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。 |
Update |
KQL クエリセットのパブリック定義要求ペイロードを更新します。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
名前 | 型 | 説明 |
---|---|---|
resourceId |
string |
エラーに関係するリソース ID。 |
resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
moreDetails |
その他のエラーの詳細の一覧。 |
|
relatedResource |
エラー関連のリソースの詳細。 |
|
requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
名前 | 型 | 説明 |
---|---|---|
errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
message |
string |
エラーの人間が判読できる表現。 |
relatedResource |
エラー関連のリソースの詳細。 |
KQLQuerysetDefinition
KQL クエリセットのパブリック定義オブジェクト。
名前 | 型 | 説明 |
---|---|---|
format |
string |
項目定義の形式。 |
parts |
定義パーツの一覧。 |
KQLQuerysetDefinitionPart
KQL クエリセット定義パーツ オブジェクト。
名前 | 型 | 説明 |
---|---|---|
path |
string |
KQL クエリセットパーツパス。 |
payload |
string |
KQL クエリセット パーツペイロード。 |
payloadType |
ペイロードの種類。 |
PayloadType
定義パーツペイロードの型。 追加のペイロードの種類は、時間の経過と同時に追加される場合があります。
値 | 説明 |
---|---|
InlineBase64 |
インライン ベース 64。 |
UpdateKQLQuerysetDefinitionRequest
KQL クエリセットのパブリック定義要求ペイロードを更新します。
名前 | 型 | 説明 |
---|---|---|
definition |
KQL クエリセットのパブリック定義オブジェクト。 |