azure.azcollection.azure_rm_virtualwan 模块 – 管理 Azure VirtualWan 实例

注意

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

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

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

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

azure.azcollection 1.5.0 中的新增功能

概要

  • 创建、更新和删除 Azure VirtualWan 的实例。

要求

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

  • 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 授权时使用。

allow_branch_to_branch_traffic

布尔值

如果允许分支到分支的流量，则为 True。

选项

  • false

  • true

allow_vnet_to_vnet_traffic

布尔值

如果允许 Vnet 到 Vnet 的流量，则为 True。

选项

  • false

  • true

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（如果存在多个订阅 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

disable_vpn_encryption

布尔值

是否禁用 VPN 加密。

选项

  • false

  • true

location

字符串

虚拟 WAN 位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必需

要检索的 VirtualWAN 的名称。

office365_local_breakout_category

字符串

指定 Office365 本地分流类别。

默认值为 None。

选项

  • "Optimize"

  • "OptimizeAndAllow"

  • "All"

  • "None"

password

字符串

Active Directory 用户密码。在通过 Active Directory 用户而非服务主体进行身份验证时使用。

profile

字符串

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

resource_group

字符串 / 必需

VirtualWan 的资源组名称。

secret

字符串

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

state

字符串

断言 VirtualWan 的状态。

使用 present 创建或更新 VirtualWan，使用 absent 删除它。

选项

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

列表 / 元素=字典

VirtualWAN 中的 VirtualHubs 列表。

id

字符串

虚拟中心资源 ID。

virtual_wan_type

字符串

VirtualWAN 的类型。

选项

  • "Basic"

  • "Standard"

vpn_sites

列表 / 元素=字典

VirtualWAN 中的 VpnSites 列表。

id

字符串

VPN 站点资源 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: Create a VirtualWan
  azure_rm_virtualwan:
    resource_group: myResouceGroup
    name: testwan
    disable_vpn_encryption: true
    allow_branch_to_branch_traffic: true
    allow_vnet_to_vnet_traffic: true
    virtual_wan_type: Standard

- name: Delete the VirtualWan
  azure_rm_virtualwan:
    resource_group: myResouceGroup
    name: testwan
    state: absent

返回值

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

键

描述

state

复杂

虚拟 WAN 的当前状态。

已返回：成功

allow_branch_to_branch_traffic

布尔值

如果允许分支到分支的流量，则为 True。

已返回：始终

示例： true

allow_vnet_to_vnet_traffic

布尔值

如果允许 Vnet 到 Vnet 流量，则为 True。

已返回：始终

示例： true

disable_vpn_encryption

布尔值

是否禁用 VPN 加密。

已返回：始终

示例： true

etag

字符串

一个唯一的只读字符串，每当资源更新时都会更改。

已返回：始终

示例： "52def36b-84b6-49aa-a825-16ba167fc559"

id

字符串

资源 ID。

已返回：始终

示例： "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/virtual_wan_name"

location

字符串

虚拟 WAN 资源位置。

已返回：始终

示例： "eastus"

name

字符串

资源名称。

已返回：始终

示例： "virtualwanb57dc9555691"

office365_local_breakout_category

字符串

Office 本地分流类别。

已返回：始终

示例： "None"

provisioning_state

字符串

虚拟 WAN 资源的预配状态。

已返回：始终

示例： "Succeeded"

tags

字典

资源标记。

已返回：始终

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

type

字符串

资源类型。

已返回：始终

示例： "Microsoft.Network/virtualWans"

virtual_hubs

复杂

VirtualWAN 中的 VirtualHubs 列表。

已返回：始终

id

字符串

虚拟中心的 ID。

已返回：始终

示例： "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/test"

virtual_wan_type

字符串

VirtualWAN 的类型。

已返回：始终

示例： "Standard"

vpn_sites

列表 / 元素=字符串

VirtualWAN 中的 VpnSites 列表。

已返回：始终

id

字符串

VPN 站点资源 ID。

已返回：始终

示例： "/subscriptions/xxx-xxx/resourceGroups/resource_group/providers/Microsoft.Network/vpnSites/test1"

作者

  • Fred-Sun (@Fred-Sun)