azure.azcollection.azure_rm_virtualnetworkpeering_info 模块 – 获取 Azure 虚拟网络对等连接的事实

注意

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

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

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

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

azure.azcollection 0.0.1 中的新增功能

概要

  • 获取 Azure 虚拟网络对等连接的事实。

要求

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

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

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，否则将选择第一个订阅。

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

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

虚拟网络对等连接的名称。

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必需

vnet 所在的资源组的名称。

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

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

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

virtual_network

any / 必填

虚拟网络的名称或资源 ID。

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get virtual network peering by name
  azure_rm_virtualnetworkpeering_info:
    resource_group: myResourceGroup
    virtual_network: myVnet1
    name: myVnetPeer

- name: List virtual network peering of virtual network
  azure_rm_virtualnetworkpeering:
    resource_group: myResourceGroup
    virtual_network: myVnet1

返回值

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

键

描述

vnetpeerings

复杂

虚拟网络对等连接事实的列表。

返回值： 总是

allow_forwarded_traffic

布尔值

是否允许/禁止来自远程虚拟网络中 VM 的转发流量。

返回值： 总是

示例： false

allow_gateway_transit

布尔值

是否可以在远程虚拟网络中使用网关链接来链接到此虚拟网络。

返回值： 总是

示例： false

allow_virtual_network_access

布尔值

链接的虚拟网络空间中的 VM 是否可以访问本地虚拟网络空间中的所有 VM。

返回值： 总是

示例： false

id

字符串

当前虚拟网络对等连接的 ID。

返回值： 总是

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/virtualNetworkPeerings/peer1"

name

字符串

虚拟网络对等连接的名称。

返回值： 总是

示例： "myPeering"

peering_state

字符串

虚拟网络对等连接的状态。

返回值： 总是

示例： "Connected"

peering_sync_level

字符串

对等连接的同步级别

返回值： 总是

示例： "FullyInSync"

provisioning_state

字符串

资源的预配状态。

返回值： 总是

示例： "Succeeded"

remote_address_space

复杂

远程虚拟网络地址空间的引用。

返回值： 总是

address_prefixes

list / elements=string

以 CIDR 表示法为此虚拟网络保留的地址块列表。

返回值： 总是

示例： ["10.1.0.0/16"]

remote_virtual_network

字符串

要与之建立对等连接的远程虚拟网络的 ID。

返回值： 总是

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet2"

use_remote_gateways

布尔值

是否可以在此虚拟网络上使用远程网关。

返回值： 总是

示例： false

作者

  • Yunge Zhu (@yungezz)