azure.azcollection.azure_rm_vpnsite 模块 – 管理 Azure VpnSite 实例

注意

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

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

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

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

azure.azcollection 1.5.0 中的新增功能

概要

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

要求

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

  • python >= 2.7

  • 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

  • 集合的 requirements.txt 文件中列出的所有 python 包必须通过 pip 安装在执行 azure.azcollection 集合中模块的主机上

  • 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 找到

参数

参数

注释

ad_user

字符串

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

address_space

字典

包含一系列 IP 地址范围的 AddressSpace。

address_prefixes

列表 / 元素=字符串

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

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

布尔值

用于控制标签字段是规范的还是仅附加到现有标签。

如果是规范的，则标签参数中找不到的任何标签都将从对象的元数据中删除。

选项

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

字典

BGP 属性集。

asn

整数

BGP 说话者的 ASN。

bgp_peering_address

字符串

此 BGP 说话者的 BGP 对等地址和 BGP 标识符。

bgp_peering_addresses

列表 / 元素=字典

带有虚拟网络网关 IP 配置 ID 的 BGP 对等地址。

custom_bgp_ip_addresses

列表 / 元素=字符串

属于 IP 配置的自定义 BGP 对等地址列表。

default_bgp_ip_addresses

列表 / 元素=字符串

属于 IP 配置的默认 BGP 对等地址列表。

ipconfiguration_id

字符串

属于网关的 IP 配置的 ID。

tunnel_ip_addresses

列表 / 元素=字符串

属于 IP 配置的隧道公共 IP 地址列表。

peer_weight

整数

添加到从此 BGP 说话者学习的路由的权重。

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"

device_properties

字典

设备属性。

device_model

字符串

设备型号。

device_vendor

字符串

设备厂商名称。

整数

链路速度。

disable_instance_discovery

布尔值

新增于 azure.azcollection 2.3.0

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

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

选项

  • false ← (默认)

  • true

ip_address

字符串

VPN 站点的 IP 地址。

is_security_site

布尔值

IsSecuritySite 标志。

选项

  • false

  • true

location

字符串

VpnSite 的位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必填

VpnSite 的名称。

o365_policy

字典

Office365 策略。

break_out_categories

字典

Office365 中断类别。

allow

布尔值

控制允许类别的标志。

选项

  • false

  • true

default

布尔值

控制默认类别的标志。

选项

  • false

  • true

optimize

布尔值

控制优化类别的标志。

选项

  • false

  • true

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必填

VpnSite 的资源组名称。

secret

字符串

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

site_key

字符串

可用于连接的 vpn 站点密钥。

state

字符串

断言 VpnSite 的状态。

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

选项

  • "absent"

  • "present" ← (默认)

subscription_id

字符串

您的 Azure 订阅 ID。

tags

字典

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

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

要删除标签，请将 append_tags 选项设置为 false。

目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。

Azure 前端门户不支持使用

Azure 自动化和 Azure CDN 每个资源仅支持 15 个标签。

tenant

字符串

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

thumbprint

字符串

新增于 azure.azcollection 1.14.0

在 *x509_certificate_path* 中指定的私钥的指纹。

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

如果定义了 *x509_certificate_path*，则需要此项。

virtual_wan

字典

vpnSite 所属的 VirtualWAN。

id

字符串

相关虚拟 WAN 的资源 ID。

列表 / 元素=字典

所有 vpn 站点链接的列表。

字典

BGP 属性集。

整数

BGP 说话者的 ASN。

字符串

此 BGP 说话者的 BGP 对等地址和 BGP 标识符。

字符串

vpn 站点链接的 FQDN。

字符串

vpn 站点链接的 IP 地址。

字典

链路提供商属性。

字符串

链路提供商名称。

整数

链路速度。

字符串

在资源组内唯一的资源名称。

此名称可用于访问资源。

x509_certificate_path

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create VpnSite
  azure_rm_vpnsite:
    resource_group: myResourceGroup
    name: vpnSite_name

- name: Delete Vpn Site
  azure_rm_vpnsite:
    resource_group: myResourceGroup
    name: vpnSite_name

返回值

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

键

描述

state

复杂

VPN 站点的当前状态。

返回： 成功

device_properties

复杂

设备属性。

返回： 始终

device_vendor

字符串

设备厂商名称。

返回： 始终

示例： "{'link_speed_in_mbps': 0}"

etag

字符串

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

返回： 始终

示例： "8d7415fe-d92c-4331-92ea-460aadfb9648"

id

字符串

资源 ID。

返回： 始终

示例： "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/vpnSites/vpn_site_name"

is_security_site

布尔值

IsSecuritySite 标志。

返回： 始终

示例： false

location

字符串

资源位置。

返回： 始终

示例： "eastus"

name

字符串

资源名称。

返回： 始终

示例： "vpn_site_name"

provisioning_state

字符串

VPN 站点资源的预配状态。

返回： 始终

示例： "Succeeded"

tags

字典

资源标签。

返回： 始终

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

type

字符串

资源类型。

返回： 始终

示例： "Microsoft.Network/vpnSites"

virtual_wan

复杂

vpnSite 所属的 VirtualWAN。

返回： 始终

id

字符串

资源 ID。

返回： 始终

示例： "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/virtualWans/virtualwan_name"

作者

  • Fred-Sun (@Fred-Sun)