azure.azcollection.azure_rm_virtualnetworkgatewayconnection_info 模块 – 获取或列出指定的虚拟网络网关连接

注意

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

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

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

要在 Playbook 中使用它，请指定：azure.azcollection.azure_rm_virtualnetworkgatewayconnection_info。

azure.azcollection 2.7.0 中的新增功能

概要

• 获取或列出指定的虚拟网络网关连接。

要求

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

• 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 字符串 / 必需	资源组的名称。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 列表 / 元素=字符串	通过提供标签列表来限制结果。将标签格式设置为“key”或“key:value”。
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 中的配置文件，或者在运行任务或 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 和 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: Gets the specified local network gateway connection by name
  azure_rm_virtualnetworkgatewayconnection_info:
    resource_group: "{{ resource_group }}"
    name: "{{ local_networkgateway_name }}"

- name: Gets all the virtual network gateway connection in a resource group
  azure_rm_virtualnetworkgatewayconnection_info:
    resource_group: "{{ resource_group }}"

- name: Gets all the virtual network gateway connection in a resource group and filter by tags
  azure_rm_virtualnetworkgatewayconnection_info:
    resource_group: "{{ resource_group }}"
    tags:
      - foo

返回值

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

键	描述
state 复杂	Azure 虚拟网络网关连接资源的当前状态。 返回： 始终
authorization_key 字符串	authorizationKey。 返回： 始终 示例： "308201E806092A864886F*************B9FADDAC2D"
connection_mode 字符串	此连接的连接模式。 返回： 始终 示例： "Default"
connection_protocol 字符串	此连接使用的连接协议。 返回： 始终 示例： "IKEv2"
connection_type 字符串	网关连接类型。 返回： 始终 示例： "Vnet2Vnet"
dpd_timeout_seconds 整数	此连接的死对等检测超时时间，以秒为单位。 返回： 始终 示例： 45
enable_bgp 布尔值	EnableBgp 标志。 返回： 始终 示例： false
etag 字符串	一个唯一的只读字符串，当资源更新时会发生变化。 返回： 始终 示例： "58b6f0c2-7d7c-4666-a62e-6416b4e00c83"
express_route_gateway_bypass 布尔值	绕过 ExpressRoute 网关进行数据转发。 返回： 始终 示例： false
id 字符串	资源 ID。 返回： 始终 示例： "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/connections/fredvnet"
ipsec_policies 列表 / 元素=字符串	此连接要考虑的 IPSec 策略。 返回： 始终 示例： []
location 字符串	资源位置。 返回： 始终 示例： "eastus"
name 字符串	资源名称。 返回： 始终 示例： "fredvnetconnection"
provisioning_state 字符串	虚拟网络网关连接资源的预配状态。 返回： 始终 示例： "Succeeded"
resource_group 字符串	虚拟网络网关连接的资源组。 返回： 始终 示例： "rg"
routing_weight 整数	路由权重。 返回： 始终 示例： 0
shared_key 字符串	IPSec 共享密钥。 返回： 始终
tags 字典	资源标签。 返回： 始终 示例： {"key1": "value1"}
traffic_selector_policies 列表 / 元素=字符串	此连接要考虑的流量选择器策略。 返回： 始终 示例： []
use_local_azure_ip_address 布尔值	为连接使用专用本地 Azure IP。 返回： 始终 示例： false
use_policy_based_traffic_selectors 布尔值	启用基于策略的流量选择器。 返回： 始终 示例： false
virtual_network_gateway1 复杂	对虚拟网络网关资源的引用。 返回： 始终
id 字符串	虚拟网络网关资源的 ID。 返回： 始终 示例： "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/virtualNetworkGateways/fredvng"
virtual_network_gateway2 复杂	对虚拟网络网关资源的引用。 返回： 始终
id 字符串	虚拟网络网关资源的 ID。 返回： 始终 示例： "/subscriptions/xxx-xxx/resourceGroups/rg/providers/Microsoft.Network/virtualNetworkGateways/fredvng02"

作者

• xuzhang3 (@xuzhang3)

• Fred Sun (@Fred-sun)

集合链接

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