您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

az datafactory pipeline

备注

此引用是 Azure CLI 的 datafactory 扩展的一部分,需要2.15.0 或更高版本。 首次运行 az datafactory 管道 命令时,扩展将自动安装。 详细了解扩展。

通过 datafactory 管理管道。

命令

az datafactory pipeline create

创建管道。

az datafactory pipeline create-run

创建管道的运行。

az datafactory pipeline delete

删除管道。

az datafactory pipeline list

列出管道。

az datafactory pipeline show

获取管道。

az datafactory pipeline update

更新管道。

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"

必需参数

--factory-name

工厂名称。

--name --pipeline-name -n

管道名称。

--pipeline

管道资源定义。 预期值: json-string/@json-file 。

--resource-group -g

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

可选参数

--if-match

管道实体的 ETag。 只应为 update 指定,它应匹配现有实体或可 * 用于无条件更新。

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"

必需参数

--factory-name

工厂名称。

--name --pipeline-name -n

管道名称。

--resource-group -g

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

可选参数

--is-recovery

恢复模式标志。 如果将恢复模式设置为 true,则指定的引用管道将运行,并且新运行将按相同的 groupId 分组。

接受的值: false, true
--parameters

管道运行的参数。 仅当未指定 runId 时,才使用这些参数。 预期值: json-string/@json-file 。

--reference-pipeline-run-id

管道运行标识符。 如果指定 "运行 ID",则将使用指定的运行的参数来创建新的运行。

--start-activity-name

在恢复模式中,重新运行将从此活动开始。 如果未指定,则将运行所有活动。

--start-from-failure

在恢复模式下,如果设置为 true,则重新运行将从失败的活动开始。 仅当未指定 startActivityName 时,才会使用属性。

接受的值: false, true

az datafactory pipeline delete

删除管道。

az datafactory pipeline delete --factory-name
                               --name
                               --resource-group
                               [--yes]

示例

Pipelines_Delete

az datafactory pipeline delete --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"

必需参数

--factory-name

工厂名称。

--name --pipeline-name -n

管道名称。

--resource-group -g

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

可选参数

--yes -y

不提示确认。

az datafactory pipeline list

列出管道。

az datafactory pipeline list --factory-name
                             --resource-group

示例

Pipelines_ListByFactory

az datafactory pipeline list --factory-name "exampleFactoryName" --resource-group "exampleResourceGroup"

必需参数

--factory-name

工厂名称。

--resource-group -g

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

az datafactory pipeline show

获取管道。

az datafactory pipeline show --factory-name
                             --name
                             --resource-group
                             [--if-none-match]

示例

Pipelines_Get

az datafactory pipeline show --factory-name "exampleFactoryName" --name "examplePipeline" --resource-group "exampleResourceGroup"

必需参数

--factory-name

工厂名称。

--name --pipeline-name -n

管道名称。

--resource-group -g

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

可选参数

--if-none-match

管道实体的 ETag。 只应为 get 指定。 如果 ETag 与现有实体标记相匹配,则为; 如果 * 提供了,则不会返回任何内容。

az datafactory pipeline update

更新管道。

az datafactory pipeline update --factory-name
                               --name
                               --resource-group
                               [--activities]
                               [--add]
                               [--annotations]
                               [--concurrency]
                               [--description]
                               [--duration]
                               [--folder-name]
                               [--force-string]
                               [--if-match]
                               [--if-none-match]
                               [--parameters]
                               [--remove]
                               [--run-dimensions]
                               [--set]
                               [--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"

必需参数

--factory-name

工厂名称。

--name --pipeline-name -n

管道名称。

--resource-group -g

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

可选参数

--activities

管道中的活动列表。 预期值: json-string/@json-file 。

--add

通过指定路径和键值对,将对象添加到对象列表中。 示例:--添加 listProperty <键 = 值、字符串或 JSON 字符串>。

--annotations

可用于描述管道的标记的列表。 预期值: json-string/@json-file 。

--concurrency

管道的最大并发运行数。

--description

管道的说明。

--duration

用于触发 Azure 监视指标的 TimeSpan 值。 预期值: json-string/@json-file 。

--folder-name

此管道所在的文件夹的名称。

--force-string

使用 "set" 或 "add" 时,保留字符串文本,而不是尝试转换为 JSON。

--if-match

管道实体的 ETag。 只应为 update 指定,它应匹配现有实体或可 * 用于无条件更新。

--if-none-match

管道实体的 ETag。 只应为 get 指定。 如果 ETag 与现有实体标记相匹配,则为; 如果 * 提供了,则不会返回任何内容。

--parameters

管道的参数列表。 预期值: json-string/@json-file 。

--remove

从列表中删除属性或元素。 示例:--remove property. list 或--Remove propertyToRemove。

--run-dimensions

管道发出的维度。 预期值: json-string/@json-file 。

--set

通过指定要设置的属性路径和值来更新对象。 示例:--set property1. property2 =.

--variables

管道的变量列表。 预期值: json-string/@json-file 。