Azure Data Factory と Azure Synapse Analytics でサポートされているシステム変数
適用対象:
Azure Data Factory Azure Synapse Analytics
ヒント
企業向けのオールインワン分析ソリューション、Microsoft Fabric の Data Factory をお試しください。 Microsoft Fabric は、データ移動からデータ サイエンス、リアルタイム分析、ビジネス インテリジェンス、レポートまで、あらゆるものをカバーしています。 無料で新しい試用版を開始する方法について説明します。
この記事では、Azure Data Factory と Azure Synapse でサポートされているシステム変数について説明します。 これらの変数は、いずれかのサービス内でエンティティを定義するときに式で使用できます。
パイプラインのスコープ
これらのシステム変数は、パイプライン JSON 内の任意の場所で参照できます。
| 変数名 | 説明 |
|---|---|
| @pipeline().DataFactory | パイプライン実行が実行されているデータまたは Synapse ワークスペースの名前 |
| @pipeline().Pipeline | パイプラインの名前 |
| @pipeline().RunId | 特定のパイプライン実行の ID |
| @pipeline().TriggerType | パイプラインを呼び出したトリガーの種類 (例: ScheduleTrigger、BlobEventsTrigger)。 サポートされているトリガーの種類の一覧については、「パイプラインの実行とトリガー」を参照してください。 Manual のトリガーの種類は、パイプラインが手動でトリガーされたことを示します。 |
| @pipeline().TriggerId | パイプラインを呼び出したトリガーの ID |
| @pipeline().TriggerName | パイプラインを呼び出したトリガーの名前 |
| @pipeline().TriggerTime | パイプラインを呼び出したトリガーの実行時刻。 これは、トリガーがパイプライン実行を呼び出すために実際に起動した時刻であり、トリガーのスケジュールされた時刻とはやや異なる場合があります。 |
| @pipeline().GroupId | パイプラインの実行が属するグループの ID。 |
| @pipeline()?.TriggeredByPipelineName | パイプラインの実行をトリガーするパイプラインの名前。 ExecutePipeline アクティビティによってパイプラインの実行がトリガーされる場合に関係します。 その他の状況で使用された場合は、Null に評価されます。 @pipeline() の後の疑問符に注意してください |
| @pipeline()?.TriggeredByPipelineRunId | パイプラインの実行をトリガーするパイプラインの実行 ID。 ExecutePipeline アクティビティによってパイプラインの実行がトリガーされる場合に関係します。 その他の状況で使用された場合は、Null に評価されます。 @pipeline() の後の疑問符に注意してください |
Note
トリガー関連の日付/時刻のシステム変数 (パイプラインとトリガーの両方のスコープ) は、ISO 8601 形式で UTC 日付を返します (例: 2017-06-01T22:20:00.4061448Z)。
スケジュール トリガーのスコープ
トリガーの種類が ScheduleTrigger の場合、これらのシステム変数は、トリガー JSON 内の任意の場所で参照できます。
| 変数名 | 説明 |
|---|---|
| @trigger().scheduledTime | トリガーがパイプライン実行を呼び出すようにスケジュールされた時間。 |
| @trigger().startTime | トリガーがパイプライン実行を呼び出すために実際に起動した時間。 これは、トリガーのスケジュールされた時刻とはやや異なる場合があります。 |
タンブリング ウィンドウ トリガーのスコープ
トリガーの種類が TumblingWindowTrigger の場合、これらのシステム変数は、トリガー JSON 内の任意の場所で参照できます。
| 変数名 | 説明 |
|---|---|
| @trigger().outputs.windowStartTime | トリガーの実行に関連付けられているウィンドウの開始。 |
| @trigger().outputs.windowEndTime | トリガーの実行に関連付けられているウィンドウの終了。 |
| @trigger().scheduledTime | トリガーがパイプライン実行を呼び出すようにスケジュールされた時間。 |
| @trigger().startTime | トリガーがパイプライン実行を呼び出すために実際に起動した時間。 これは、トリガーのスケジュールされた時刻とはやや異なる場合があります。 |
ストレージ イベント トリガーのスコープ
トリガーの種類が BlobEventsTrigger の場合、これらのシステム変数は、トリガー JSON 内の任意の場所で参照できます。
| 変数名 | 説明 |
|---|---|
| @triggerBody().fileName | 作成または削除によってトリガーが起動されたファイルの名前。 |
| @triggerBody().folderPath | @triggerBody().fileName で指定されたファイルを含むフォルダーへのパス。 フォルダー パスの最初のセグメントは、Azure Blob Storage コンテナーの名前です。 |
| @trigger().startTime | パイプライン実行を呼び出すためにトリガーが起動した時刻。 |
Note
Azure Synapse Analytics でパイプラインとトリガーを作成する場合は、パラメーターとして @trigger().outputs.body.fileName と @trigger().outputs.body.folderPath を使用する必要があります。 これら 2 つのプロパティによって、BLOB 情報がキャプチャされます。 @triggerBody().fileName と @triggerBody().folderPath の代わりに、これらのプロパティを使用してください。
カスタム イベント トリガーのスコープ
トリガーの種類が CustomEventsTrigger の場合、これらのシステム変数は、トリガー JSON 内の任意の場所で参照できます。
Note
サービスでは、Azure Event Grid イベント スキーマを使用してカスタム イベントを書式設定する必要があります。
| 変数名 | 説明 |
|---|---|
| @triggerBody().event.eventType | カスタム イベント トリガーの実行をトリガーしたイベントの種類。 イベントの種類は、顧客が定義したフィールドで、文字列型の任意の値を取ります。 |
| @triggerBody().event.subject | トリガーを起動するカスタム イベントの件名。 |
| @triggerBody().event.data._keyName_ | カスタム イベントのデータ フィールドは、JSON BLOB から無料で利用でき、顧客がメッセージとデータを送信するために使用できます。 各フィールドを参照するには、data.keyName を使用します。 たとえば、@triggerBody().event.data.callback は、[データ] の下に格納されている [コールバック] フィールドの値を返します。 |
| @trigger().startTime | パイプライン実行を呼び出すためにトリガーが起動した時刻。 |
関連するコンテンツ
- これらの変数を式で使用する方法については、式言語と関数に関するページを参照してください。
- パイプラインでトリガー スコープ システム変数を使用するには、パイプライン実行でのトリガー メタデータの参照に関する記事を参照してください。