azure.azcollection.azure_rm_privatednszonelink_info 模块 – 获取私有 DNS 区域的虚拟网络链接信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

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

azure.azcollection 1.6.0 中的新增功能

概要

• 获取指定的虚拟网络链接或私有 DNS 区域的所有虚拟网络链接信息。

要求

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

• python >= 2.7

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

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

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

参数

参数	注释
ad_user string	Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url string 在 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且具有自己的 ADFS 授权时使用。
api_profile string 在 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时要使用的 API 配置文件。默认值 latest 适用于公共云；未来的值将允许与 Azure Stack 一起使用。 默认值： "latest"
auth_source string 在 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，否则选择第一个订阅。 msi 在 Ansible 2.6 中添加。 选项 "auto" ← （默认） "cli" "credential_file" "env" "msi"
cert_validation_mode string 在 azure.azcollection 0.0.1 中添加	控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。 选项 "ignore" "validate"
client_id string	Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 AZURE_CLIENT_ID 环境变量设置。
cloud_environment string 在 azure.azcollection 0.0.1 中添加	对于美国公共云以外的云环境，环境名称（如 Azure Python SDK 定义的，例如 AzureChinaCloud、AzureUSGovernment）或元数据发现终结点 URL（Azure Stack 需要）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认值： "AzureCloud"
disable_instance_discovery boolean 在 azure.azcollection 2.3.0 中添加	确定在尝试身份验证时是否执行实例发现。将此项设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。实例发现过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此项设置为 **True**，禁用授权验证。因此，至关重要的是要确保配置的授权主机是有效且值得信赖的。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ← （默认） true
log_mode string	父参数。
log_path string	父参数。
name string	虚拟网络链接的名称。
password string	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile string	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group string / 必填	资源组的名称。
secret string	Azure 客户端密钥。使用服务主体进行身份验证时使用。
subscription_id string	您的 Azure 订阅 ID。
tags list / elements=string	通过提供标签列表来限制结果。将标签格式化为 ‘key’ 或 ‘key:value’。
tenant string	Azure 租户 ID。使用服务主体进行身份验证时使用。
thumbprint string 添加于 azure.azcollection 1.14.0	x509_certificate_path 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需项。
x509_certificate_path path 添加于 azure.azcollection 1.14.0	用于以 PEM 格式创建服务主体的 X509 证书的路径。 证书必须附加到私钥。 使用服务主体进行身份验证时使用。
zone_name string / 必填	私有 DNS 区域的名称。

注释

注意

• 对于 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 中。这是一个 ini 文件，其中包含 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant，或者 subscription_id、ad_user 和 password。还可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get facts for one virtual network link in private DNS zone
  azure_rm_privatednszonelink_info:
    resource_group: myResourceGroup
    name: vnetlink1
    zone_name: privatezone.com

- name: Get facts for all virtual network links in private DNS zone
  azure_rm_privatednszonelink_info:
    resource_group: myResourceGroup
    zone_name: privatezone.com

返回值

通用返回值记录在此处：此处，以下是此模块独有的字段

键

描述

virtualnetworklinks list / elements=dictionary

获取私有 DNS 区域中虚拟网络链接字典的列表。 返回: 始终 示例: [{"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/ Microsoft.Network/privateDnsZones/privatezone.com/virtualNetworkLinks/vnetlink1", "name": "vnetlink1", "provisioning_state": "Succeeded", "registration_enabled": true, "tags": {"key1": "value1"}, "virtual_network": {"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/ providers/Microsoft.Network/virtualNetworks/MyAzureVNet"}, "virtual_network_link_state": "Completed"}]

作者

• Aparna Patil (@techcon65)

集合链接

• 问题跟踪器
• 主页
• 存储库 (源代码)