你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az datafactory pipeline-run

注意

此参考是 Azure CLI(版本 2.15.0 或更高版本)的数据工厂扩展的一部分。 该扩展将在首次运行 az datafactory pipeline-run 命令时自动安装。 详细了解扩展。

使用 datafactory 管理管道运行。

命令

名称 说明 类型 状态
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"

可选参数

--factory-name

工厂名称。

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--is-recursive

如果为 true,请取消当前管道触发的所有子管道。

接受的值: false, true
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--run-id

管道运行标识符。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --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"

必需参数

--last-updated-after

运行事件以“ISO 8601”格式更新的时间或之后的时间。

--last-updated-before

运行事件以“ISO 8601”格式更新的时间或之前的时间。

可选参数

--continuation-token

用于获取下一页结果的延续标记。 第一页的 Null。

--factory-name

工厂名称。

--filters

筛选器列表。

用法:--filters operand=XX operator=XX values=XX

操作数:必需。 要用于筛选器的参数名称。 允许的操作数查询管道运行是 PipelineName、RunStart、RunEnd 和 Status;到查询活动运行的是 ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType 和 Status,以及查询触发器运行是 TriggerName、TriggerRunTimestamp 和 Status。 运算符:必需。 要用于筛选器的运算符。 值:必需。 筛选器值列表。

可以使用多个 --filters 参数指定多个操作。

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--order-by

OrderBy 选项的列表。

用法:--order-by order-by=XX order=XX

order-by:必需。 要用于排序依据的参数名称。 管道运行允许的参数是 PipelineName、RunStart、RunEnd 和 Status;对于活动运行,为 ActivityName、ActivityRunStart、ActivityRunEnd 和 Status;对于触发器运行,为 TriggerName、TriggerRunTimestamp 和 Status。 order:必需。 参数的排序顺序。

可以使用多个 --order-by 参数指定多个操作。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --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"

可选参数

--factory-name

工厂名称。

--ids

一个或多个资源 ID(空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--run-id

管道运行标识符。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。