azure.azcollection.azure_rm_virtualhub 模块 – 管理 Azure VirtualHub 实例

注意

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

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

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

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

azure.azcollection 1.10.0 中的新增功能

概要

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

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

字符串

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

address_prefix

字符串

此 VirtualHub 的地址前缀。

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"

azure_firewall

字典

与此 VirtualHub 关联的 azureFirewall。

id

字符串

资源 ID。

bgp_connections

列表 / 元素=字典

对 Bgp 连接的引用列表。

id

字符串

资源 ID。

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_virtual_router_route_propogation

布尔值

用于控制 VirtualRouter 中心路由传播的标志。

选项

  • false

  • true

express_route_gateway

字典

与此 VirtualHub 关联的 expressRouteGateway。

id

字符串

资源 ID。

ip_configurations

列表 / 元素=字典

IpConfigurations 的引用列表。

id

字符串

资源 ID。

location

字符串

VirtualHub 的位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

string / 必需

VirtualHub 的名称。

p2_s_vpn_gateway

字典

与此 VirtualHub 关联的 P2SVpnGateway。

id

字符串

资源 ID。

password

字符串

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

profile

字符串

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

resource_group

string / 必需

VirtualHub 的资源组名称。

route_table

字典

与此虚拟中心关联的路由表。

routes

列表 / 元素=字典

所有路由的列表。

address_prefixes

list / elements=string

所有 addressPrefixes 的列表。

next_hop_ip_address

字符串

下一跳 IP 地址。

secret

字符串

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

security_partner_provider

字典

与此 VirtualHub 关联的 securityPartnerProvider。

id

字符串

资源 ID。

security_provider_name

字符串

安全提供商名称。

sku

字符串

此 VirtualHub 的 SKU。

state

字符串

断言 VirtualHub 的状态。

使用 present 创建或更新 VirtualHub，使用 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，则为必需项。

virtual_hub_route_table_v2_s

列表 / 元素=字典

与此 VirtualHub 关联的所有虚拟中心路由表 v2 的列表。

attached_connections

list / elements=string

附加到此路由表 v2 的所有连接的列表。

name

字符串

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

此名称可用于访问资源。

routes

列表 / 元素=字典

所有路由的列表。

destination_type

字符串

目的地的类型。

destinations

list / elements=string

所有目的地的列表。

next_hop_type

字符串

下一跳的类型。

next_hops

list / elements=string

下一跳 IP 地址。

virtual_router_asn

整数

VirtualRouter ASN。

virtual_router_ips

list / elements=string

VirtualRouter IP。

virtual_wan

字典

VirtualHub 所属的 VirtualWAN。

id

字符串

资源 ID。

vpn_gateway

字典

与此 VirtualHub 关联的 VpnGateway。

id

字符串

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

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create a VirtualHub
  azure_rm_virtualhub:
    resource_group: myResourceGroup
    name: my_virtual_hub_name
    address_prefix: 10.2.0.0/24
    sku: Standard
    location: eastus
    enable_virtual_router_route_propogation: false
    virtual_wan:
      id: /subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/fredwan

- name: Delete VirtualHub
  azure_rm_virtualhub:
    resource_group: myResourceGroup
    name: my_virtual_hub_name
    location: eastus
    state: absent

返回值

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

键

描述

state

复杂

虚拟中心的当前状态。

返回: 始终

address_prefix

字符串

此 VirtualHub 的地址前缀。

返回: 始终

示例: "10.2.0.0/24"

azure_firewall

复杂

与此 VirtualHub 关联的 azureFirewall。

返回: 始终

id

字符串

资源 ID。

返回: 始终

bgp_connections

list / elements=string

对 Bgp 连接的引用列表。

返回: 始终

id

字符串

资源 ID。

返回: 始终

enable_virtual_router_route_propogation

布尔值

用于控制 VirtualRouter 中心路由传播的标志。

返回: 始终

etag

字符串

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

返回: 始终

示例: "cf8c0b06-d339-4155-95fd-2a363945cce4"

express_route_gateway

字典

与此 VirtualHub 关联的 expressRouteGateway。

返回: 始终

id

字符串

资源 ID。

返回: 始终

id

字符串

资源 ID。

返回: 始终

示例: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualHubs/my_virtual_hub_name"

ip_configurations

list / elements=string

IpConfigurations 的引用列表。

返回: 始终

id

字符串

资源 ID。

返回: 始终

location

字符串

资源位置。

返回: 始终

示例: "eastus"

name

字符串

资源名称。

返回: 始终

示例: "my_virtual_hub_name"

p2_s_vpn_gateway

复杂

与此 VirtualHub 关联的 P2SVpnGateway。

返回: 始终

id

字符串

资源 ID。

返回: 始终

provisioning_state

字符串

虚拟中心资源的预配状态。

返回: 始终

示例: "Succeeded"

route_table

复杂

与此虚拟中心关联的路由表。

返回: 始终

routes

list / elements=string

所有路由的列表。

返回: 始终

address_prefixes

list / elements=string

所有 addressPrefixes 的列表。

返回: 始终

next_hop_ip_address

字符串

下一跳 IP 地址。

返回: 始终

routing_state

字符串

路由状态。

返回: 始终

示例: "Standard"

security_partner_provider

复杂

与此 VirtualHub 关联的 securityPartnerProvider。

返回: 始终

id

字符串

资源 ID。

返回: 始终

security_provider_name

字符串

安全提供商名称。

返回: 始终

sku

字符串

此 VirtualHub 的 SKU。

返回: 始终

tags

字典

资源标签。

返回: 始终

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

type

字符串

资源类型。

返回: 始终

示例: "Microsoft.Network/virtualHubs"

virtual_hub_route_table_v2_s

复杂

与此 VirtualHub 关联的所有虚拟中心路由表 v2 的列表。

返回: 始终

attached_connections

list / elements=string

附加到此路由表 v2 的所有连接的列表。

返回: 始终

name

字符串

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

此名称可用于访问资源。

返回: 始终

routes

list / elements=string

所有路由的列表。

返回: 始终

destination_type

字符串

目的地的类型。

返回: 始终

destinations

list / elements=string

所有目的地的列表。

返回: 始终

next_hop_type

字符串

下一跳的类型。

返回: 始终

next_hops

list / elements=string

下一跳 IP 地址。

返回: 始终

virtual_router_asn

整数

VirtualRouter ASN。

返回: 始终

virtual_router_ips

list / elements=string

VirtualRouter IP。

返回: 始终

virtual_wan

复杂

VirtualHub 所属的 VirtualWAN。

返回: 始终

id

字符串

资源 ID。

返回: 始终

示例: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualWans/fredwan"

vpn_gateway

复杂

与此 VirtualHub 关联的 VpnGateway。

返回: 始终

id

字符串

资源 ID。

返回: 始终

作者

  • Fred-Sun (@Fred-Sun)

  • Haiyuan Zhang (@haiyuazhang)