azure.azcollection.azure_rm_datafactory 模块 – 托管数据工厂

注意

此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在剧本中使用它，请指定：azure.azcollection.azure_rm_datafactory。

azure.azcollection 0.1.12 中的新增功能

概要

• 创建、更新或删除数据工厂。

要求

执行此模块的主机需要以下要求。

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合的 requirements.txt 中列出的所有 python 包

• 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到

参数

参数	注释
ad_user 字符串	Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串 在 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。当使用用户名/密码进行身份验证并且具有您自己的 ADFS 授权时使用。
api_profile 字符串 在 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公共云；未来的值将允许与 Azure Stack 一起使用。 默认值： "latest"
append_tags 布尔值	用于控制 tags 字段是规范的还是仅附加到现有标签。 当为规范时，在 tags 参数中找不到的任何标签将从对象的元数据中删除。 选项 false true ← (默认)
auth_source 字符串 在 azure.azcollection 0.0.1 中添加	控制用于身份验证的凭据来源。 也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。 设置为 auto（默认值）时，优先级为模块参数 -> env -> credential_file -> cli。 设置为 env 时，凭据将从环境变量中读取 设置为 credential_file 时，它将从 ~/.azure/credentials 中读取配置文件。 设置为 cli 时，凭据将来自 Azure CLI 配置文件。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果存在多个订阅 ID），否则将使用默认的 az cli 订阅。 设置为 msi 时，主机必须是启用了 MSI 扩展的 azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果该资源被授予对多个订阅的访问权限），否则将选择第一个订阅。 msi 在 Ansible 2.6 中添加。 选项 "auto" ← (默认) "cli" "credential_file" "env" "msi"
cert_validation_mode 字符串 在 azure.azcollection 0.0.1 中添加	控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理时，或者针对 Azure Stack，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。 选项 "ignore" "validate"
client_id 字符串	Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 AZURE_CLIENT_ID 环境变量设置。
cloud_environment 字符串 在 azure.azcollection 0.0.1 中添加	对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment）或元数据发现终结点 URL（Azure Stack 所需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认值： "AzureCloud"
disable_instance_discovery 布尔值 在 azure.azcollection 2.3.0 中添加	确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 获取授权元数据以验证授权。通过将其设置为 True，将禁用授权验证。因此，确保配置的授权主机有效且可信至关重要。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ← (默认) true
if_match 字符串	工厂实体的 ETag。 应仅在获取时指定。 如果 ETag 与现有实体标签匹配，或者提供了 *，则不会返回任何内容。
location 字符串	有效的 Azure 位置。默认为资源组的位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name string / 必需	工厂名称。
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而非服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
public_network_access 字符串	是否允许数据工厂进行公共网络访问。 选项 "Enabled" "Disabled"
repo_configuration dictionary	数据工厂存储库配置。
account_name string / 必需	帐户名称。
collaboration_branch string / 必需	协作分支。
project_name 字符串	VSTS 项目名称。 当 type=FactoryVSTSConfiguration 时为必需。
repository_name string / 必需	存储库名称。
root_folder string / 必需	根文件夹。
type string / 必需	存储库配置的类型。 选项 "FactoryGitHubConfiguration" "FactoryVSTSConfiguration"
resource_group string / 必需	按资源组限制结果。使用名称参数时为必需。
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
state 字符串	断言公共 IP 的状态。使用 present 创建或更新，使用 absent 删除。 选项 "absent" "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags dictionary	字符串:字符串对的字典，用于将元数据分配给对象。 对象上的元数据标签将使用任何提供的值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标签。
tenant 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
x509_certificate_path path 在 azure.azcollection 1.14.0 中添加	用于创建 PEM 格式服务主体的 X509 证书的路径。 证书必须附加到私钥。 使用服务主体进行身份验证时使用。

注释

注意

• 要使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或 playbook 之前使用 az login 登录。

• 也可以使用服务主体或 Active Directory 用户进行身份验证。

• 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或者设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

• 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和密码，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

• 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个 ini 文件，包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。还可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Create the data factory
  azure_rm_datafactory:
    resource_group: "{{ resource_group }}"
    name: "{{ name }}"
    repo_configuration:
      type: FactoryGitHubConfiguration
      account_name: Fred-sun
      collaboration_branch: testbranch
      root_folder: "./"
      repository_name: vault

返回值

常见返回值在 此处 记录，以下是此模块特有的字段

Key	描述
state complex	数据工厂的当前状态。 返回: 总是
create_time 字符串	工厂以 ISO8601 格式创建的时间。 返回: 总是 示例: "2022-04-26T08:24:41.391164+00:00"
e_tag 字符串	Etag 标识资源中的更改。 返回: 总是 示例: "3000fa80-0000-0100-0000-6267ac490000"
id 字符串	数据工厂 ID。 返回: 总是 示例: "/subscriptions/xxx-xxx/resourceGroups/testRG/providers/Microsoft.DataFactory/factories/testpro"
identity 字符串	工厂的托管服务标识。 返回: 总是
principal_id 字符串	标识的主体 ID。 返回: 总是 示例: "***********"
tenant_id 字符串	标识的客户端租户 ID。 返回: 总是 示例: "***********"
location 字符串	资源位置。 返回: 总是 示例: "eastus"
name 字符串	资源名称。 返回: 总是 示例: "testfactory"
provisioning_state 字符串	工厂预配状态，例如“Succeeded”。 返回: 总是 示例: "Succeeded"
public_network_access 字符串	是否允许数据工厂进行公共网络访问。 返回: 总是 示例: "Enabled"
repo_configuration 字符串	工厂的 Git 存储库信息。 返回: 总是
ccount_name 字符串	帐户名称。 返回: 总是 示例: "fredaccount"
collaboration_branch 字符串	协作分支。 返回: 总是 示例: "branch"
repository_name 字符串	存储库名称。 返回: 总是 示例: "vault"
root_folder 字符串	根文件夹。 返回: 总是 示例: "/home/"
type 字符串	存储库配置的类型。 返回: 总是 示例: "FactoryGitHubConfiguration"
tags 字符串	列出数据工厂标签。 返回: 总是 示例: "{'key1': 'value1'}"
type 字符串	资源类型。 返回: 总是 示例: "Microsoft.DataFactory/factories"

作者

• Fred-sun (@Fred-sun)

• xuzhang3 (@xuzhang3)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）