azure.azcollection.azure_rm_privateendpointdnszonegroup 模块 – 创建、更新或管理私有终结点 DNS 区域组。

注意

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

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

要安装它，请使用： ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求了解详情。

要在 playbook 中使用它，请指定： azure.azcollection.azure_rm_privateendpointdnszonegroup。

azure.azcollection 1.10.0 中的新增功能

概要

  • 创建、更新或管理私有终结点 DNS 区域组。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

字符串

活动目录用户名。在使用活动目录用户而不是服务主体进行身份验证时使用。

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"

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（如果存在多个），否则使用默认的 az cli 订阅。

设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。

Ansible 2.6 中添加了 msi。

选项

  • "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

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必填

专用端点DNS区域组的名称。

password

字符串

Active Directory用户密码。在使用Active Directory用户而不是服务主体进行身份验证时使用。

private_dns_zone_configs

列表 / 元素=字典

专用DNS区域配置。

name

字符串

专用DNS区域配置的名称。

private_dns_zone

字符串

专用DNS区域的名称。

如果设置，则获取当前资源组下的专用DNS区域。

private_dns_zone_id

字符串

专用DNS区域的ID。

如果设置，则获取指定连接的专用DNS区域的值。

private_endpoint

字符串 / 必填

专用端点的名称。

profile

字符串

在~/.azure/credentials文件中找到的安全配置文件。

resource_group

字符串 / 必填

专用端点的资源组。

secret

字符串

Azure客户端密钥。在使用服务主体进行身份验证时使用。

state

字符串

专用端点DNS区域组的状态。使用present创建或更新，使用absent删除。

选项

  • "absent"

  • "present" ← (默认)

subscription_id

字符串

您的Azure订阅ID。

tenant

字符串

Azure租户ID。在使用服务主体进行身份验证时使用。

thumbprint

字符串

azure.azcollection 1.14.0版本中添加

在x509_certificate_path中指定的私钥的指纹。

在使用服务主体进行身份验证时使用。

如果定义了x509_certificate_path，则为必填项。

x509_certificate_path

路径

azure.azcollection 1.14.0版本中添加

PEM格式下用于创建服务主体的X509证书的路径。

证书必须附加到私钥。

在使用服务主体进行身份验证时使用。

备注

注意

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

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

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

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

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

另请参见

另请参见

使用Azure CLI登录

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

示例

- name: Create zone group for private endpoint
  azure_rm_privateendpointdnszonegroup:
    name: "my-zone-group"
    private_endpoint: "my-private-endpoint"
    resource_group: "my-resource-group"
    private_dns_zone_configs:
      - name: "default"
        private_dns_zone: "privatelink.postgres.database.azure.com"

- name: Create zone group for private endpoint
  azure_rm_privateendpointdnszonegroup:
    name: "my-zone-group"
    private_endpoint: "my-private-endpoint"
    resource_group: "my-resource-group"
    state: "absent"

返回值

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

键

描述

state

复杂

专用端点区域组的当前状态。

返回：始终

id

字符串

专用端点区域组的资源ID。

返回：始终

示例："/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/ myPrivateEndpoint/privateDnsZoneGroups/myZoneGroup"

name

字符串

专用端点区域组的名称。

返回：始终

示例："myZoneGroup"

private_dns_zone_configs

列表 / 元素=字符串

区域组内的区域配置列表。

返回：始终

name

字符串

区域配置的名称。

返回：始终

示例："default"

private_dns_zone_id

字符串

专用DNS区域的ID。

返回：始终

示例："/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/ privateDnsZones/privatelink.postgres.database.azure.com"

record_sets

列表 / 元素=字符串

区域的DNS记录列表。

返回：始终

fqdn

字符串

记录的完全限定域名。

返回：始终

示例："myPostgreSqlSrv-123.privatelink.postgres.database.azure.com"

ip_addresses

列表 / 元素=字符串

记录的IP地址。

返回：始终

示例：["10.1.0.4"]

provisioning_state

字符串

资源的预配状态。

返回：始终

示例："Succeeded"

record_set_name

字符串

记录的名称。

返回：始终

示例："myPostgreSqlSrv-123"

record_type

字符串

记录的类型。

返回：始终

示例："A"

ttl

整数

记录的生存时间值。

返回：始终

示例：10

provisioning_state

字符串

资源的预配状态。

返回：始终

示例："Succeeded"

作者

  • Ross Bender (@l3ender)