az datafactory pipeline-run
Note
このリファレンスは、Azure CLI (バージョン 2.15.0 以降) のデータファクトリ拡張機能の一部です。 拡張機能は、az datafactory pipeline-run コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
データ ファクトリを使用してパイプラインの実行を管理します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az datafactory pipeline-run cancel |
実行 ID で実行されるパイプラインを取り消します。 |
拡張 | GA |
az datafactory pipeline-run query-by-factory |
クエリ パイプラインは、入力フィルター条件に基づいてファクトリで実行されます。 |
拡張 | GA |
az datafactory pipeline-run show |
実行 ID で実行されるパイプラインを取得します。 |
拡張 | GA |
az datafactory pipeline-run cancel
実行 ID で実行されるパイプラインを取り消します。
az datafactory pipeline-run cancel [--factory-name]
[--ids]
[--is-recursive {false, true}]
[--resource-group]
[--run-id]
[--subscription]
例
PipelineRuns_Cancel
az datafactory pipeline-run cancel --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --run-id "16ac5348-ff82-4f95-a80d-638c1d47b721"
省略可能のパラメーター
ファクトリ名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
true の場合は、現在のパイプラインによってトリガーされるすべての子パイプラインを取り消します。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
パイプライン実行の識別子。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory pipeline-run query-by-factory
クエリ パイプラインは、入力フィルター条件に基づいてファクトリで実行されます。
az datafactory pipeline-run query-by-factory --last-updated-after
--last-updated-before
[--continuation-token]
[--factory-name]
[--filters]
[--ids]
[--order-by]
[--resource-group]
[--subscription]
例
PipelineRuns_QueryByFactory
az datafactory pipeline-run query-by-factory --factory-name "exampleFactoryName" --filters operand="PipelineName" operator="Equals" values="examplePipeline" --last-updated-after "2018-06-16T00:36:44.3345758Z" --last-updated-before "2018-06-16T00:49:48.3686473Z" --resource-group "exampleResourceGroup"
必須のパラメーター
実行イベントが 'ISO 8601' 形式で更新された時刻以降。
実行イベントが 'ISO 8601' 形式で更新された時刻またはそれ以前。
省略可能のパラメーター
結果の次のページを取得するための継続トークン。 最初のページの場合は Null。
ファクトリ名。
フィルターの一覧。
使用法: --filters operand=XX operator=XX values=XX
オペランド: 必須。 フィルターに使用するパラメーター名。 パイプライン実行のクエリに使用できるオペランドは、PipelineName、RunStart、RunEnd、Status です。アクティビティ実行のクエリには ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType、Status があり、クエリ トリガーの実行には TriggerName、TriggerRunTimestamp、Status があります。 演算子: 必須。 フィルターに使用する演算子。 values: 必須。 フィルター値の一覧。
複数の --filters 引数を使用して、複数のアクションを指定できます。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
OrderBy オプションの一覧。
使用法: --order-by order-by=XX order=XX
order-by: 必須。 順序付けに使用するパラメーター名。 パイプラインの実行で順序付けできるパラメーターは、PipelineName、RunStart、RunEnd、Status です。アクティビティの実行は ActivityName、ActivityRunStart、ActivityRunEnd、Status です。トリガーの実行には、TriggerName、TriggerRunTimestamp、および Status があります。 order: 必須。 パラメーターの並べ替え順序。
複数のアクションを指定するには、複数の --order-by 引数を使用します。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az datafactory pipeline-run show
実行 ID で実行されるパイプラインを取得します。
az datafactory pipeline-run show [--factory-name]
[--ids]
[--resource-group]
[--run-id]
[--subscription]
例
PipelineRuns_Get
az datafactory pipeline-run show --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup" --run-id "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b"
省略可能のパラメーター
ファクトリ名。
1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
リソース グループの名前。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
パイプライン実行の識別子。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI