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

az datafactory

注意

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

管理数据工厂。

命令

名称	说明	类型	状态
az datafactory activity-run	使用 datafactory 管理活动运行。	分机	GA
az datafactory activity-run query-by-pipeline-run	查询活动基于输入筛选器条件运行。	分机	GA
az datafactory configure-factory-repo	汇报工厂的存储库信息。	分机	GA
az datafactory create	创建工厂。	扩展	GA
az datafactory data-flow	在Azure 数据工厂中管理和配置数据流。	分机	GA
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 dataset	使用 datafactory 管理数据集。	扩展	GA
az datafactory dataset create	创建数据集。	分机	GA
az datafactory dataset delete	删除数据集。	分机	GA
az datafactory dataset list	列出数据集。	分机	GA
az datafactory dataset show	获取数据集。	分机	GA
az datafactory dataset update	更新数据集。	扩展	GA
az datafactory delete	删除工厂。	分机	GA
az datafactory get-data-plane-access	获取数据平面访问权限。	分机	GA
az datafactory get-git-hub-access-token	获取 GitHub 访问令牌。	分机	GA
az datafactory integration-runtime	使用 datafactory 管理集成运行时。	扩展	GA
az datafactory integration-runtime-node	使用 datafactory 管理集成运行时节点。	扩展	GA
az datafactory integration-runtime-node delete	删除自承载集成运行时节点。	分机	GA
az datafactory integration-runtime-node get-ip-address	获取自承载集成运行时节点的 IP 地址。	分机	GA
az datafactory integration-runtime-node show	获取自承载集成运行时节点。	分机	GA
az datafactory integration-runtime-node update	汇报自承载集成运行时节点。	分机	GA
az datafactory integration-runtime delete	删除集成运行时。	分机	GA
az datafactory integration-runtime get-connection-info	获取用于加密本地数据源凭据的本地集成运行时连接信息。	分机	GA
az datafactory integration-runtime get-monitoring-data	获取集成运行时监视数据，其中包括此集成运行时下所有节点的监视数据。	扩展	GA
az datafactory integration-runtime get-status	获取集成运行时的详细状态信息。	分机	GA
az datafactory integration-runtime linked-integration-runtime	使用 datafactory 子组 linked-integration-runtime 管理集成运行时。	分机	GA
az datafactory integration-runtime linked-integration-runtime create	在共享集成运行时中创建链接的集成运行时条目。	扩展	GA
az datafactory integration-runtime list	列出集成运行时。	分机	GA
az datafactory integration-runtime list-auth-key	检索集成运行时的身份验证密钥。	扩展	GA
az datafactory integration-runtime managed	使用托管的 datafactory 子组管理集成运行时。	扩展	GA
az datafactory integration-runtime managed create	创建集成运行时。	分机	GA
az datafactory integration-runtime regenerate-auth-key	重新生成集成运行时的身份验证密钥。	扩展	GA
az datafactory integration-runtime remove-link	删除自承载集成运行时中特定数据工厂下的所有链接集成运行时。	分机	GA
az datafactory integration-runtime self-hosted	使用自承载 Datafactory 子组管理集成运行时。	扩展	GA
az datafactory integration-runtime self-hosted create	创建集成运行时。	分机	GA
az datafactory integration-runtime show	获取集成运行时。	分机	GA
az datafactory integration-runtime start	启动 ManagedReserved 类型集成运行时。	扩展	GA
az datafactory integration-runtime stop	停止 ManagedReserved 类型集成运行时。	分机	GA
az datafactory integration-runtime sync-credentials	强制集成运行时跨集成运行时节点同步凭据，这将覆盖所有工作器节点上的凭据，并在调度程序节点上可用凭据。 如果已有最新的凭据备份文件，则应在任何自承载集成运行时节点上手动导入它（首选），而不是直接使用此 API。	分机	GA
az datafactory integration-runtime update	汇报集成运行时。	分机	GA
az datafactory integration-runtime upgrade	将自承载集成运行时升级到最新版本（如果可用性）。	分机	GA
az datafactory integration-runtime wait	将 CLI 置于等待状态，直到满足 datafactory integration-runtime 的条件。	扩展	GA
az datafactory linked-service	使用 datafactory 管理链接服务。	扩展	GA
az datafactory linked-service create	创建链接服务。	分机	GA
az datafactory linked-service delete	删除链接服务。	分机	GA
az datafactory linked-service list	列出链接的服务。	扩展	GA
az datafactory linked-service show	获取链接服务。	分机	GA
az datafactory linked-service update	更新链接服务。	分机	GA
az datafactory list	列出工厂。 列出指定订阅下的工厂。	分机	GA
az datafactory managed-private-endpoint	使用 datafactory 管理托管专用终结点。	扩展	预览
az datafactory managed-private-endpoint create	创建托管专用终结点。	分机	预览
az datafactory managed-private-endpoint delete	删除托管专用终结点。	分机	预览版
az datafactory managed-private-endpoint list	列出托管专用终结点。	分机	预览
az datafactory managed-private-endpoint show	获取托管专用终结点。	扩展	预览
az datafactory managed-private-endpoint update	更新托管专用终结点。	分机	预览版
az datafactory managed-virtual-network	使用 datafactory 管理托管虚拟网络。	分机	预览版
az datafactory managed-virtual-network create	创建托管虚拟网络。	扩展	预览版
az datafactory managed-virtual-network list	列出托管虚拟网络。	扩展	预览版
az datafactory managed-virtual-network show	获取托管虚拟网络。	分机	预览
az datafactory managed-virtual-network update	更新托管虚拟网络。	扩展	预览版
az datafactory pipeline	使用 datafactory 管理管道。	分机	GA
az datafactory pipeline-run	使用 datafactory 管理管道运行。	分机	GA
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 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 show	获取工厂。	分机	GA
az datafactory trigger	使用 datafactory 管理触发器。	分机	GA
az datafactory trigger-run	使用 datafactory 管理触发器运行。	分机	GA
az datafactory trigger-run cancel	按 runId 取消单个触发器实例。	扩展	GA
az datafactory trigger-run query-by-factory	查询触发器运行。	扩展	GA
az datafactory trigger-run rerun	按 runId 重新运行单个触发器实例。	分机	GA
az datafactory trigger create	创建触发器。	扩展	GA
az datafactory trigger delete	删除触发器。	扩展	GA
az datafactory trigger get-event-subscription-status	获取触发器的事件订阅状态。	分机	GA
az datafactory trigger list	列出触发器。	扩展	GA
az datafactory trigger query-by-factory	查询触发器。	扩展	GA
az datafactory trigger show	获取触发器。	扩展	GA
az datafactory trigger start	启动触发器。	扩展	GA
az datafactory trigger stop	停止触发器。	扩展	GA
az datafactory trigger subscribe-to-event	将事件触发器订阅到事件。	分机	GA
az datafactory trigger unsubscribe-from-event	取消订阅事件触发器的事件。	分机	GA
az datafactory trigger update	更新触发器。	分机	GA
az datafactory trigger wait	将 CLI 置于等待状态，直到满足数据工厂触发器的条件。	扩展	GA
az datafactory update	汇报工厂。	分机	GA

az datafactory configure-factory-repo

汇报工厂的存储库信息。

az datafactory configure-factory-repo [--factory-git-hub-configuration]
                                      [--factory-resource-id]
                                      [--factory-vsts-configuration]
                                      [--ids]
                                      [--location]
                                      [--subscription]

示例

Factories_ConfigureFactoryRepo

az datafactory configure-factory-repo --factory-resource-id "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName" --factory-vsts-configuration account-name="ADF" collaboration-branch="master" last-commit-id="" project-name="project" repository-name="repo" root-folder="/" tenant-id="" --location "East US"

可选参数

--factory-git-hub-configuration --github-config

工厂的 GitHub 存储库信息。

用法：--factory-git-hub-configuration host-name=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX

主机名：GitHub Enterprise 主机名。 例如： https://github.mydomain.com 类型：必需。 存储库配置的类型。 account-name：必需。 帐户名。 repository-name：必需。 存储库名称。 协作分支：必需。 协作分支。 root-folder：必需。 根文件夹。 last-commit-id：上次提交 ID。

--factory-resource-id

工厂资源 ID。

--factory-vsts-configuration --vsts-config

工厂的 VSTS 存储库信息。

用法：--factory-vsts-configuration project-name=XX tenant-id=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX

project-name：必需。 VSTS 项目名称。 tenant-id：VSTS 租户 ID。类型：必需。 存储库配置的类型。 account-name：必需。 帐户名。 repository-name：必需。 存储库名称。 协作分支：必需。 协作分支。 root-folder：必需。 根文件夹。 last-commit-id：上次提交 ID。

--ids

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

--location -l

位置。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--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 create

创建工厂。

az datafactory create --factory-name
                      --resource-group
                      [--factory-git-hub-configuration]
                      [--factory-vsts-configuration]
                      [--global-parameters]
                      [--if-match]
                      [--location]
                      [--public-network-access]
                      [--tags]

示例

Factories_CreateOrUpdate

az datafactory create --location "East US" --name "exampleFactoryName" --resource-group "exampleResourceGroup"

必需参数

--factory-name --name -n

工厂名称。

--resource-group -g

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

可选参数

--factory-git-hub-configuration --github-config

工厂的 GitHub 存储库信息。

用法：--factory-git-hub-configuration host-name=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX

主机名：GitHub Enterprise 主机名。 例如： https://github.mydomain.com 类型：必需。 存储库配置的类型。 account-name：必需。 帐户名。 repository-name：必需。 存储库名称。 协作分支：必需。 协作分支。 root-folder：必需。 根文件夹。 last-commit-id：上次提交 ID。

--factory-vsts-configuration --vsts-config

工厂的 VSTS 存储库信息。

用法：--factory-vsts-configuration project-name=XX tenant-id=XX type=XX account-name=XX repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX

project-name：必需。 VSTS 项目名称。 tenant-id：VSTS 租户 ID。类型：必需。 存储库配置的类型。 account-name：必需。 帐户名。 repository-name：必需。 存储库名称。 协作分支：必需。 协作分支。 root-folder：必需。 根文件夹。 last-commit-id：上次提交 ID。

--global-parameters

工厂的参数列表。 预期值：json-string/json-file/@json-file。

--if-match

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

--location -l

位置。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--public-network-access

是否允许对数据工厂进行公用网络访问。

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

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

删除工厂。

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

示例

Factories_Delete

az datafactory delete --name "exampleFactoryName" --resource-group "exampleResourceGroup"

可选参数

--factory-name --name -n

工厂名称。

--ids

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

--resource-group -g

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

--subscription

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

--yes -y

不提示确认。

默认值: False

全局参数

--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 get-data-plane-access

获取数据平面访问权限。

az datafactory get-data-plane-access [--access-resource-path]
                                     [--expire-time]
                                     [--factory-name]
                                     [--ids]
                                     [--permissions]
                                     [--profile-name]
                                     [--resource-group]
                                     [--start-time]
                                     [--subscription]

示例

Factories_GetDataPlaneAccess

az datafactory get-data-plane-access --name "exampleFactoryName" --access-resource-path "" --expire-time "2018-11-10T09:46:20.2659347Z" --permissions "r" --profile-name "DefaultProfile" --start-time "2018-11-10T02:46:20.2659347Z" --resource-group "exampleResourceGroup"

可选参数

--access-resource-path

要获取相对于工厂的访问权限的资源路径。 目前仅支持与工厂资源对应的空字符串。

--expire-time

令牌的过期时间。 令牌的最大持续时间为 8 小时，默认情况下令牌将在 8 小时内过期。

--factory-name --name -n

工厂名称。

--ids

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

--permissions

具有数据平面访问权限的字符串。 目前仅支持“r”授予只读访问权限。

--profile-name

配置文件的名称。 目前仅支持默认值。 默认值为 DefaultProfile。

--resource-group -g

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

--start-time

令牌的开始时间。 如果未指定，将使用当前时间。

--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 get-git-hub-access-token

获取 GitHub 访问令牌。

az datafactory get-git-hub-access-token --git-hub-access-code
                                        --git-hub-access-token-base-url
                                        [--factory-name]
                                        [--git-hub-client-id]
                                        [--ids]
                                        [--resource-group]
                                        [--subscription]

示例

Factories_GetGitHubAccessToken

az datafactory get-git-hub-access-token --name "exampleFactoryName" --git-hub-access-code "some" --git-hub-access-token-base-url "some" --git-hub-client-id "some" --resource-group "exampleResourceGroup"

必需参数

--git-hub-access-code

GitHub 访问代码。

--git-hub-access-token-base-url

GitHub 访问令牌基 URL。

可选参数

--factory-name --name -n

工厂名称。

--git-hub-client-id

GitHub 应用程序客户端 ID。

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

列出工厂。 列出指定订阅下的工厂。

az datafactory list [--resource-group]

示例

Factories_ListByResourceGroup

az datafactory list --resource-group "exampleResourceGroup"

Factories_List

az datafactory list

可选参数

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

获取工厂。

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

示例

Factories_Get

az datafactory show --name "exampleFactoryName" --resource-group "exampleResourceGroup"

可选参数

--factory-name --name -n

工厂名称。

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

汇报工厂。

az datafactory update [--factory-name]
                      [--ids]
                      [--public-network-access]
                      [--resource-group]
                      [--subscription]
                      [--tags]

示例

Factories_Update

az datafactory update --name "exampleFactoryName" --tags exampleTag="exampleValue" --resource-group "exampleResourceGroup"

可选参数

--factory-name --name -n

工厂名称。

--ids

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

--public-network-access

是否允许对数据工厂进行公用网络访问。

--resource-group -g

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

--subscription

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

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数

--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 获取完整的调试日志。