az datafactory
Note
此参考是 Azure CLI(版本 2.15.0 或更高版本) 的数据工厂 扩展的一部分。 该扩展将在首次运行 az datafactory 命令时自动安装。 了解更多关于扩展的信息。
管理数据工厂。
命令
az datafactory configure-factory-repo
更新工厂的存储库信息。
az datafactory configure-factory-repo [--factory-git-hub-configuration --github-config]
[--factory-resource-id]
[--factory-vsts-configuration --vsts-config]
[--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"
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
工厂的 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。
| 属性 | 值 |
|---|---|
| Parameter group: | RepoConfiguration Arguments |
工厂资源 ID。
工厂的 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。
| 属性 | 值 |
|---|---|
| Parameter group: | RepoConfiguration Arguments |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az datafactory create
创建工厂。
az datafactory create --factory-name --name
--resource-group
[--factory-git-hub-configuration --github-config]
[--factory-vsts-configuration --vsts-config]
[--global-parameters]
[--if-match]
[--location]
[--public-network-access]
[--tags]
示例
Factories_CreateOrUpdate
az datafactory create --location "East US" --name "exampleFactoryName" --resource-group "exampleResourceGroup"
必需参数
工厂名称。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
工厂的 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。
| 属性 | 值 |
|---|---|
| Parameter group: | RepoConfiguration Arguments |
工厂的 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。
| 属性 | 值 |
|---|---|
| Parameter group: | RepoConfiguration Arguments |
工厂的参数列表。 预期值:json-string/json-file/@json-file。
工厂实体的 ETag。 应仅指定用于更新,应将其与现有实体匹配,也可以为 * 进行无条件更新。
Location.
az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。
是否允许对数据工厂进行公用网络访问。
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az datafactory delete
删除工厂。
az datafactory delete [--factory-name --name]
[--ids]
[--resource-group]
[--subscription]
[--yes]
示例
Factories_Delete
az datafactory delete --name "exampleFactoryName" --resource-group "exampleResourceGroup"
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
工厂名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
不要提示确认。
| 属性 | 值 |
|---|---|
| 默认值: | False |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az datafactory get-data-plane-access
获取数据平面访问权限。
az datafactory get-data-plane-access [--access-resource-path]
[--expire-time]
[--factory-name --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"
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
要获取相对于工厂的访问权限的资源路径。 目前仅支持与工厂资源对应的空字符串。
令牌的过期时间。 令牌的最大持续时间为 8 小时,默认情况下令牌将在 8 小时内过期。
工厂名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
具有数据平面访问权限的字符串。 目前仅支持“r”授予只读访问权限。
配置文件的名称。 目前仅支持默认值。 默认值为 DefaultProfile。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
令牌的开始时间。 如果未指定,将使用当前时间。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
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 --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"
必需参数
GitHub 访问代码。
GitHub 访问令牌基 URL。
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
工厂名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
GitHub 应用程序客户端 ID。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az datafactory list
列出工厂。 列出指定订阅下的工厂。
az datafactory list [--resource-group]
示例
Factories_ListByResourceGroup
az datafactory list --resource-group "exampleResourceGroup"
Factories_List
az datafactory list
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az datafactory show
获取工厂。
az datafactory show [--factory-name --name]
[--ids]
[--if-none-match]
[--resource-group]
[--subscription]
示例
Factories_Get
az datafactory show --name "exampleFactoryName" --resource-group "exampleResourceGroup"
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
工厂名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
工厂实体的 ETag。 应仅指定 get。 如果 ETag 与现有实体标记匹配,或者如果提供 *,则不会返回任何内容。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
az datafactory update
更新工厂。
az datafactory update [--factory-name --name]
[--ids]
[--public-network-access]
[--resource-group]
[--subscription]
[--tags]
示例
Factories_Update
az datafactory update --name "exampleFactoryName" --tags exampleTag="exampleValue" --resource-group "exampleResourceGroup"
可选参数
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
工厂名称。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
是否允许对数据工厂进行公用网络访问。
资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。
| 属性 | 值 |
|---|---|
| Parameter group: | Resource Id Arguments |
空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。
全局参数
提高日志记录详细程度以显示所有调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |
显示此帮助消息并退出。
仅显示错误,禁止显示警告。
| 属性 | 值 |
|---|---|
| 默认值: | False |
输出格式。
| 属性 | 值 |
|---|---|
| 默认值: | json |
| 接受的值: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
增加日志记录详细程度。 使用 --debug 获取完整的调试日志。
| 属性 | 值 |
|---|---|
| 默认值: | False |