Background Jobs - Run On Demand Execute
オンデマンド実行ジョブ インスタンスを実行します。
Note
この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。 この API の URL が更新され、パスの一部としてジョブの種類が含まれるようになっており、クエリ パラメーターの以前の使用を置き換えます。 下位互換性のために、クエリ パラメーターを使用した呼び出しは引き続きサポートされています。
必要な委任されたスコープ
データフロー API の場合は、次のスコープの種類を使用します。
- 特定のスコープ: Dataflow.Execute.All
スコープの詳細については、scopes に関する記事を参照してください。
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| Identity | Support |
|---|---|
| User | Yes |
| サービス プリンシパルとマネージド ID | No |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/Execute/instancesURI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
dataflow
|
path | True |
string (uuid) |
データフロー ID。 |
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
要求本文
| 名前 | 型 | 説明 |
|---|---|---|
| executionData |
オンデマンド実行ジョブ要求のペイロード。 データフローでパラメーター化が有効になっている場合にのみ必要です。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 202 Accepted |
要求が受け入れられ、ジョブの実行が進行中です。 ヘッダー
|
|
| Other Status Codes |
一般的なエラー コード:
|
例
| Run dataflow Execute job instance with no request body example |
| Run dataflow Execute job instance with request body containing parameters example |
Run dataflow Execute job instance with no request body example
要求のサンプル
POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances
応答のサンプル
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60Run dataflow Execute job instance with request body containing parameters example
要求のサンプル
POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/Execute/instances
{
"executionData": {
"executeOption": "ApplyChangesIfNeeded",
"parameters": [
{
"parameterName": "OrderKey",
"type": "Automatic",
"value": 25
},
{
"parameterName": "Threshold",
"type": "Automatic",
"value": "start"
}
]
}
}
応答のサンプル
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60定義
| 名前 | 説明 |
|---|---|
|
Dataflow |
データフローの実行データ ペイロード |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Execute |
実行操作を実行するためのオプション。 時間の経過と同時に追加の executeOptions が追加される場合があります。 |
|
Item |
パラメーターの詳細。 |
|
Run |
オンデマンド実行データフロー ジョブ インスタンス ペイロード |
| Type |
パラメーターの型。 追加のパラメーター型は、時間の経過と同時に追加される場合があります。 |
DataflowExecutionPayload
データフローの実行データ ペイロード
| 名前 | 型 | 説明 |
|---|---|---|
| executeOption |
実行操作を実行するためのオプション。 時間の経過と同時に追加の executeOptions が追加される場合があります。 |
|
| parameters |
実行中にオーバーライドするパラメーターの一覧。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
ExecuteOption
実行操作を実行するためのオプション。 時間の経過と同時に追加の executeOptions が追加される場合があります。
| 値 | 説明 |
|---|---|
| SkipApplyChanges |
既定値。 変更の適用操作はスキップされます。 |
| ApplyChangesIfNeeded |
Appply Changes 操作は、必要に応じて実行されます。 実行に最新の変更が必要な場合に使用できます。 |
ItemJobParameter
パラメーターの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| parameterName |
string |
パラメーターの名前。 |
| type |
パラメーターの型。 追加のパラメーター型は、時間の経過と同時に追加される場合があります。 |
|
| value |
実行中にオーバーライドするパラメーターの値。 |
RunOnDemandDataflowExecuteJobRequest
オンデマンド実行データフロー ジョブ インスタンス ペイロード
| 名前 | 型 | 説明 |
|---|---|---|
| executionData |
オンデマンド実行ジョブ要求のペイロード。 データフローでパラメーター化が有効になっている場合にのみ必要です。 |
Type
パラメーターの型。 追加のパラメーター型は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Automatic |
値は Automatic である必要があります |