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

az datafactory data-flow

参考

注意

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

在Azure 数据工厂中管理和配置数据流。

命令

名称	说明	类型	Status
az datafactory data-flow create	在工厂中创建数据流。	扩展	GA
az datafactory data-flow delete	删除给定工厂中的特定数据流。	扩展	GA
az datafactory data-flow list	列出提供的工厂中的数据流。	分机	GA
az datafactory data-flow show	显示有关指定数据流的信息。	扩展	GA
az datafactory data-flow update	汇报工厂中的指定数据流。	分机	GA

az datafactory data-flow create

在工厂中创建数据流。

az datafactory data-flow create --data-flow-name
                                --factory-name
                                --flow-type
                                --properties
                                --resource-group
                                [--if-match]

示例

Factories_DataFlowCreate

az datafactory data-flow create -g example-resource-group -f example-data-factory -n example-data-flow -t "Flowlet" --properties example-properties.json

必需参数

--data-flow-name --name -n

数据流名称。

--factory-name -f

工厂名称。

--flow-type -t

数据流类型。有效选项：MappingDataFlow、Flowlet。

--properties

数据流的指定属性。预期值：json-string/json-file/@json-file。

用法：（如果内联 JSON） --properties “{”name“： ”hello“， ”description“： ”Example description“， ”folder“： ”sub-folder“， ”annotations“： ” ， typeProperties：{...} }”

名称：数据流的名称。（避免连字符。）
说明：（可选）数据流的说明。
文件夹：（可选）数据流将组织到的文件夹。
批注：（可选）数据流的注释。
typeProperties：（可选）如果未提供，则会创建泛型定义和空定义。通过从 Azure 门户中的数据工厂工作室中复制 JSON，可以最好地包括定义。

--resource-group -g

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

可选参数

--if-match

数据流实体的 ETag。应仅指定用于更新，应将其与现有实体匹配，也可以为 * 进行无条件更新。

全局参数

--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 data-flow delete

删除给定工厂中的特定数据流。

az datafactory data-flow delete [--data-flow-name]
                                [--factory-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

示例

Factories_DataFlowDelete

az datafactory data-flow delete -g example-resource-group -f example-data-factory -n example-data-flow

可选参数

--data-flow-name --name -n

数据流名称。

--factory-name -f

工厂名称。

--ids

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

--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 data-flow list

列出提供的工厂中的数据流。

az datafactory data-flow list --factory-name
                              --resource-group

示例

Factories_DataFlowList

az datafactory data-flow list -g example-resource-group -f example-data-factory

必需参数

--factory-name -f

工厂名称。

--resource-group -g

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

全局参数

--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 data-flow show

显示有关指定数据流的信息。

az datafactory data-flow show [--data-flow-name]
                              [--factory-name]
                              [--ids]
                              [--if-none-match]
                              [--resource-group]
                              [--subscription]

示例

Factories_DataFlowShow

az datafactory data-flow show -g example-resource-group -f example-data-factory -n example-data-flow

可选参数

--data-flow-name --name -n

数据流名称。

--factory-name -f

工厂名称。

--ids

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

--if-none-match

管道实体的 ETag。应仅指定 get。如果 ETag 与现有实体标记匹配，或者如果提供 *，则不会返回任何内容。

--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 data-flow update

汇报工厂中的指定数据流。

az datafactory data-flow update --properties
                                [--data-flow-name]
                                [--factory-name]
                                [--ids]
                                [--resource-group]
                                [--subscription]

示例

Factories_DataFlowUpdate

az datafactory data-flow update -g example-resource-group -f example-data-factory -n example-data-flow --properties example-properties.json

必需参数

--properties

数据流的指定属性。预期值：json-string/json-file/@json-file。

用法：（如果内联 JSON） --properties “{ ”description“： ”Example description“， ”folder“： ”sub-folder“， ”annotations“： ” ， typeProperties：{...} }”

说明：（可选）数据流的说明。
文件夹：（可选）数据流将组织到的文件夹。
批注：（可选）数据流的注释。
typeProperties：（可选）如果未提供，则会创建泛型定义和空定义。通过从 Azure 门户中的数据工厂工作室中复制 JSON，可以最好地包括定义。

可选参数

--data-flow-name --name -n

数据流名称。

--factory-name -f

工厂名称。

--ids

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

--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 data-flow

命令

az datafactory data-flow create

示例

必需参数

可选参数

az datafactory data-flow delete

示例

可选参数

az datafactory data-flow list

示例

必需参数

az datafactory data-flow show

示例

可选参数

az datafactory data-flow update

示例

必需参数

可选参数

其他资源