azure.azcollection.azure_rm_virtualnetworkgateway 模块 – 管理 Azure 虚拟网络网关

注意

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

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

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

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

azure.azcollection 0.0.1 中的新增功能

概要 

创建、更新或删除虚拟网络网关（VPN 网关）。
创建 VPN 网关时，必须提供现有虚拟网络的名称。

要求 

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

python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
所有在集合的 requirements.txt 中列出的 python 包必须通过 pip 安装在执行来自 azure.azcollection 的模块的主机上
完整的安装说明可以在 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。当为规范时，在 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"`
bgp_settings 字典	虚拟网络网关的 BGP 对等设置。
asn 整数 / 必需	BGP 对等方的 ASN。
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`
enable_bgp 布尔值	是否为此虚拟网络网关启用 BGP。选择 `false` ← (默认) `true`
gateway_type 字符串	此虚拟网络网关的类型。选择 `"vpn"` ← (默认) `"express_route"`
ip_configurations 列表 / 元素=字典	IP 配置列表。
name 字符串 / 必需	IP 配置的名称。
private_ip_allocation_method 字符串	私有 IP 分配方法。选择 `"Dynamic"` ← (默认) `"Static"`
public_ip_address_name 字符串	公共 IP 地址的名称。使用“None”禁用公共 IP 地址。
subnet 字符串	VPN 的网关子网的 ID。
location 字符串	有效的 Azure 位置。默认为资源组的位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必需	VPN 网关的名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	VPN 网关存在或将要创建的资源组的名称。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
sku 字符串	VirtualNetworkGatewaySku 资源的引用，该资源表示为虚拟网络网关选择的 SKU。选择 `"VpnGw1"` ← (默认) `"VpnGw2"` `"VpnGw3"` `"Standard"` `"Basic"` `"HighPerformance"`
state 字符串	VPN 网关的状态。使用 `present` 创建或更新 VPN 网关，使用 `absent` 删除 VPN 网关。选择 `"absent"` `"present"` ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的 string:string 对的字典。对象上的元数据标签将使用任何提供的值进行更新。要删除标签，请将 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，则为必需。
virtual_network 别名: virtual_network_name 任何	将与 VPN 网关关联的现有虚拟网络。创建 VPN 网关时必需。可以是虚拟网络的名称。当按名称指定时，必须与 VPN 网关位于同一资源组中。可以是虚拟网络的资源 ID。可以是包含虚拟网络的 name 和 resource_group 的字典。创建时必需。
vpn_gateway_generation 字符串	此 VirtualNetworkGateway 的生成。如果 `gateway_type` 不是 VPN，则必须为 `None`。选择 `"None"` `"Generation1"` ← (默认) `"Generation2"`
vpn_type 字符串	此虚拟专用网络的类型。选择 `"route_based"` ← (默认) `"policy_based"`
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: Create virtual network gateway without bgp settings
  azure_rm_virtualnetworkgateway:
    resource_group: myResourceGroup
    name: myVirtualNetworkGateway
    ip_configurations:
      - name: testipconfig
        private_ip_allocation_method: Dynamic
        public_ip_address_name: testipaddr
    virtual_network: myVirtualNetwork
    tags:
      common: "xyz"

- name: Create virtual network gateway Generation2
  azure_rm_virtualnetworkgateway:
    resource_group: myResourceGroup
    name: myVirtualNetworkGateway
    sku: vpn_gw2
    vpn_gateway_generation: Generation2
    ip_configurations:
      - name: testipconfig
        private_ip_allocation_method: Dynamic
        public_ip_address_name: testipaddr
    virtual_network: myVirtualNetwork
    tags:
      common: "xyz"

- name: Create virtual network gateway with bgp
  azure_rm_virtualnetworkgateway:
    resource_group: myResourceGroup
    name: myVirtualNetworkGateway
    sku: vpn_gw1
    ip_configurations:
      - name: testipconfig
        private_ip_allocation_method: Dynamic
        public_ip_address_name: testipaddr
    enable_bgp: true
    virtual_network: myVirtualNetwork
    bgp_settings:
      asn: 65515
      bgp_peering_address: "169.254.54.209"
    tags:
      common: "xyz"

- name: Delete instance of virtual network gateway
  azure_rm_virtualnetworkgateway:
    resource_group: myResourceGroup
    name: myVirtualNetworkGateway
    state: absent

返回值 

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

键	描述
id 字符串	虚拟网络网关资源 ID。返回: 始终示例: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworkGateways/myV irtualNetworkGateway"`

作者

Madhura Naniwadekar (@Madhura-CSI)