你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az datafactory pipeline
注意
此参考是 Azure CLI(版本 2.15.0 或更高版本)的数据工厂扩展的一部分。 该扩展将在首次运行 az datafactory pipeline 命令时自动安装。 详细了解扩展。
使用 datafactory 管理管道。
命令
名称 | 说明 | 类型 | Status |
---|---|---|---|
az datafactory pipeline create |
创建管道。 |
扩展 | GA |
az datafactory pipeline create-run |
创建管道的运行。 |
扩展 | GA |
az datafactory pipeline delete |
删除管道。 |
扩展 | GA |
az datafactory pipeline list |
列出管道。 |
扩展 | GA |
az datafactory pipeline show |
获取管道。 |
扩展 | GA |
az datafactory pipeline update |
更新管道。 |
扩展 | GA |
az datafactory pipeline create
创建管道。
az datafactory pipeline create --factory-name
--name
--pipeline
--resource-group
[--if-match]
示例
Pipelines_Create
az datafactory pipeline create --factory-name "exampleFactoryName" --pipeline "{\"activities\":[{\"name\":\"ExampleForeachActivity\",\"type\":\"ForEach\",\"typeProperties\":{\"activities\":[{\"name\":\"ExampleCopyActivity\",\"type\":\"Copy\",\"inputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":\"examplecontainer.csv\",\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"outputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":{\"type\":\"Expression\",\"value\":\"@item()\"},\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"typeProperties\":{\"dataIntegrationUnits\":32,\"sink\":{\"type\":\"BlobSink\"},\"source\":{\"type\":\"BlobSource\"}}}],\"isSequential\":true,\"items\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.OutputBlobNameList\"}}}],\"parameters\":{\"JobId\":{\"type\":\"String\"},\"OutputBlobNameList\":{\"type\":\"Array\"}},\"variables\":{\"TestVariableArray\":{\"type\":\"Array\"}},\"runDimensions\":{\"JobId\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.JobId\"}},\"duration\":\"0.00:10:00\"}" --name "examplePipeline" --resource-group "exampleResourceGroup"
必需参数
工厂名称。
管道名称。
管道资源定义。 预期值:json-string/json-file/@json-file。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
管道实体的 ETag。 应仅指定用于更新,应将其与现有实体匹配,也可以为 * 进行无条件更新。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory pipeline create-run
创建管道的运行。
az datafactory pipeline create-run --factory-name
--name
--resource-group
[--is-recovery {false, true}]
[--parameters]
[--reference-pipeline-run-id]
[--start-activity-name]
[--start-from-failure {false, true}]
示例
Pipelines_CreateRun
az datafactory pipeline create-run --factory-name "exampleFactoryName" --parameters "{\"OutputBlobNameList\":[\"exampleoutput.csv\"]}" --name "examplePipeline" --resource-group "exampleResourceGroup"
必需参数
工厂名称。
管道名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
恢复模式标志。 如果恢复模式设置为 true,则指定的引用管道运行,并将新运行分组到同一 groupId 下。
管道运行的参数。 仅当未指定 runId 时,才会使用这些参数。 预期值:json-string/json-file/@json-file。
管道运行标识符。 如果指定运行 ID,则指定运行的参数将用于创建新运行。
在恢复模式下,重新运行将从此活动开始。 如果未指定,则所有活动都将运行。
在恢复模式下,如果设置为 true,则重新运行将从失败的活动开始。 仅当未指定 startActivityName 时,才会使用该属性。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory pipeline delete
删除管道。
az datafactory pipeline delete [--factory-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
示例
Pipelines_Delete
az datafactory pipeline delete --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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 获取完整的调试日志。
az datafactory pipeline list
列出管道。
az datafactory pipeline list --factory-name
--resource-group
示例
Pipelines_ListByFactory
az datafactory pipeline list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"
必需参数
工厂名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az datafactory pipeline show
获取管道。
az datafactory pipeline show [--factory-name]
[--ids]
[--if-none-match]
[--name]
[--resource-group]
[--subscription]
示例
Pipelines_Get
az datafactory pipeline show --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"
可选参数
工厂名称。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
管道实体的 ETag。 应仅指定 get。 如果 ETag 与现有实体标记匹配,或者如果提供 *,则不会返回任何内容。
管道名称。
资源组的名称。 可以使用 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 update
更新管道。
az datafactory pipeline update [--activities]
[--add]
[--annotations]
[--concurrency]
[--description]
[--duration]
[--factory-name]
[--folder-name]
[--force-string]
[--ids]
[--if-match]
[--if-none-match]
[--name]
[--parameters]
[--remove]
[--resource-group]
[--run-dimensions]
[--set]
[--subscription]
[--variables]
示例
Pipelines_Update
az datafactory pipeline update --factory-name "exampleFactoryName" --description "Example description" --activities "[{\"name\":\"ExampleForeachActivity\",\"type\":\"ForEach\",\"typeProperties\":{\"activities\":[{\"name\":\"ExampleCopyActivity\",\"type\":\"Copy\",\"inputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":\"examplecontainer.csv\",\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"outputs\":[{\"type\":\"DatasetReference\",\"parameters\":{\"MyFileName\":{\"type\":\"Expression\",\"value\":\"@item()\"},\"MyFolderPath\":\"examplecontainer\"},\"referenceName\":\"exampleDataset\"}],\"typeProperties\":{\"dataIntegrationUnits\":32,\"sink\":{\"type\":\"BlobSink\"},\"source\":{\"type\":\"BlobSource\"}}}],\"isSequential\":true,\"items\":{\"type\":\"Expression\",\"value\":\"@pipeline().parameters.OutputBlobNameList\"}}}]" --parameters "{\"OutputBlobNameList\":{\"type\":\"Array\"}}" --duration "0.00:10:00" --name "examplePipeline" --resource-group "exampleResourceGroup"
可选参数
管道中的活动列表。 预期值:json-string/json-file/@json-file。
通过指定路径和键值对将对象添加到对象列表。 示例:--add property.listProperty <key=value, string or JSON string>
。
可用于描述管道的标记列表。 预期值:json-string/json-file/@json-file。
管道的最大并发运行数。
管道的说明。
TimeSpan 值,之后将触发 Azure 监视指标。 预期值:json-string/json-file/@json-file。
工厂名称。
此管道所在的文件夹的名称。
使用“set”或“add”时,保留字符串文本,而不是尝试转换为 JSON。
一个或多个资源 ID(以空格分隔)。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 ID”参数。
管道实体的 ETag。 应仅指定用于更新,应将其与现有实体匹配,也可以为 * 进行无条件更新。
管道实体的 ETag。 应仅指定 get。 如果 ETag 与现有实体标记匹配,或者如果提供 *,则不会返回任何内容。 默认值为 None。
管道名称。
管道的参数列表。 预期值:json-string/json-file/@json-file。
从列表中删除属性或元素。 示例: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
管道发出的维度。 预期值:json-string/json-file/@json-file。
通过指定要设置的属性路径和值来更新对象。 示例:--set property1.property2=<value>
。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
管道的变量列表。 预期值:json-string/json-file/@json-file。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。