az datafactory pipeline-run
Note
このリファレンスは、Azure CLI (バージョン 2.15.0 以降) の データファクトリ 拡張機能の一部です。 拡張機能は、az datafactory pipeline-run コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
データ ファクトリを使用してパイプラインの実行を管理します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az datafactory pipeline-run cancel |
実行 ID で実行されるパイプラインを取り消します。 |
Extension | GA |
| az datafactory pipeline-run query-by-factory |
クエリ パイプラインは、入力フィルター条件に基づいてファクトリで実行されます。 |
Extension | GA |
| az datafactory pipeline-run show |
実行 ID で実行されるパイプラインを取得します。 |
Extension | 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"
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ファクトリ名。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
true の場合は、現在のパイプラインによってトリガーされるすべての子パイプラインを取り消します。
| プロパティ | 値 |
|---|---|
| 指定可能な値: | false, true |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
パイプライン実行識別子。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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' 形式で更新された時刻またはそれ以前。
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
結果の次のページを取得するための継続トークン。 最初のページの場合は Null。
ファクトリ名。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
フィルターの一覧。
使用法: --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' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
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>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
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"
省略可能のパラメーター
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
ファクトリ名。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
リソース グループの名前。
az configure --defaults group=<name>を使用して既定のグループを構成できます。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
パイプライン実行識別子。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
| プロパティ | 値 |
|---|---|
| Parameter group: | Resource Id Arguments |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |