azure.azcollection.azure_rm_virtualnetworkgatewayconnection 模块 – 在资源组中管理 Azure 虚拟网络网关连接

注意

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

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

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

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

azure.azcollection 2.7.0 中的新增功能

概要

  • 在资源组中创建、更新或删除 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"

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

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

msi 在 Ansible 2.6 中添加。

选项

  • "auto" ← (默认)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

authorization_key

字符串

authorizationKey。

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"

connection_protocol

字符串

用于此连接的连接协议。

选项

  • "IKEv2"

  • "IKEv1"

connection_type

字符串

网关连接类型。

选项

  • "IPsec"

  • "Vnet2Vnet"

  • "ExpressRoute"

  • "VPN客户端"

禁用实例发现

布尔值

在 azure.azcollection 2.3.0 中添加

确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。实例发现过程需要从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将其设置为 **True**，将禁用授权验证。因此，务必确保配置的授权主机有效且可信。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选项

  • false ← （默认）

  • true

dpd_timeout_seconds

整数

此连接的死对等检测超时时间（以秒为单位）。

enable_bgp

布尔值

启用 BGP 标志。

选项

  • false

  • true

express_route_gateway_bypass

布尔值

绕过 ExpressRoute 网关进行数据转发。

选项

  • false

  • true

local_network_gateway2

字符串

对本地网络网关资源的引用。

location

字符串

网络网关连接的位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必需

网络网关连接的名称。

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必需

网络网关连接的资源组。

routing_weight

整数

路由权重。

secret

字符串

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

shared_key

字符串

IPSec 共享密钥。

state

字符串

使用 present 创建或更新虚拟网络网关连接。

使用 absent 删除虚拟网络网关连接。

选项

  • "absent"

  • "present" ← （默认）

subscription_id

字符串

您的 Azure 订阅 ID。

tags

字典

要作为元数据分配给对象的字符串：字符串对的字典。

对象的元数据标记将使用任何提供的值进行更新。

要删除标记，请将 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，则为必需项。

use_local_azure_ip_address

布尔值

使用连接的私有本地 Azure IP。

选项

  • false

  • true

use_policy_based_traffic_selectors

布尔值

启用基于策略的流量选择器。

选项

  • false

  • true

virtual_network_gateway1

字符串

对虚拟网络网关资源的引用。

virtual_network_gateway2

字符串

对虚拟网络网关资源的引用。

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 和密码，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create a new virtual network gateway connection
  azure_rm_virtualnetworkgatewayconnection:
    resource_group: "{{ resource_group }}"
    name: "new{{ rpfx }}"
    virtual_network_gateway1: "{{ virtual_network_gateway1 }}"
    virtual_network_gateway2: "{{ virtual_network_gateway2 }}"
    local_network_gateway2: "{{ local_network_gateway2 }}"
    authorization_key: Password@0329
    connection_type: Vnet2Vnet
    connection_protocol: IKEv2
    routing_weight: 1
    dpd_timeout_seconds: 60
    enable_bgp: false
    use_local_azure_ip_address: false
    use_policy_based_traffic_selectors: false
    express_route_gateway_bypass: false
    tags:
      key1: value1

- name: Delete network gateway connection
  virtualnetworkgatewayconnection:
    resource_group: "{{ resource_group }}"
    name: "localgateway-name"
    state: absent

返回值

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

键

描述

state

复杂

Azure 本地网络网关资源的当前状态。

返回： 始终

authorization_key

字符串

authorizationKey。

返回： 始终

示例： "308201E806092A864********************78B9FADDAC2D"

connection_mode

字符串

此连接的连接模式。

返回： 始终

示例： "Default"

connection_protocol

字符串

用于此连接的连接协议。

返回： 始终

示例： "IKEv2"

connection_type

字符串

网关连接类型。

返回： 始终

示例： "Vnet2Vnet"

dpd_timeout_seconds

整数

此连接的死对等检测超时时间（以秒为单位）。

返回： 始终

示例： 45

enable_bgp

布尔值

启用 BGP 标志。

返回： 始终

示例： 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

列表 / elements=字符串

此连接要考虑的 IPSec 策略。

返回： 始终

示例： []

location

字符串

资源位置。

返回： 始终

示例： "eastus"

name

字符串

资源名称。

返回： 始终

示例： "fredvnetconnection"

provisioning_state

字符串

虚拟网络网关连接资源的预配状态。

返回： 始终

示例： "Succeeded"

resource_group

字符串

虚拟网络网关连接的资源组。

返回： 始终

示例： "rg"

routing_weight

整数

路由权重。

返回： 始终

示例： 0

shared_key

字符串

IPSec 共享密钥。

返回： 始终

tags

字典

资源标签。

返回： 始终

示例： {"key1": "value1"}

traffic_selector_policies

列表 / elements=字符串

此连接要考虑的流量选择器策略。

返回： 始终

示例： []

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)