azure.azcollection.azure_rm_virtualhub_info 模块 – 获取 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_info。

azure.azcollection 1.10.0 中的新增功能

概要

  • 获取 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 用户而不是服务主体进行身份验证时使用。

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"

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

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

VirtualHub 的名称。

password

字符串

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

profile

字符串

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

resource_group

字符串

VirtualHub 的资源组名称。

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

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

如果定义了 x509_certificate_path，则为必需。

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

参见

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get virtual hub info by name
  azure_rm_virtualhub_info:
    resource_group: myResourceGroup
    name: virtualHub

- name: Get virtual hub info by resource group
  azure_rm_virtualhub_info:
    resource_group: myResourceGroup

- name: Get birtual hub info by sub
  azure_rm_virtualhub_info:

返回值

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

键

描述

virtual_hubs

复杂

字典结果的列表，其中键是 VirtualHub 的名称，值是该 VirtualHub 的事实。

返回： 始终

address_prefix

字符串

此 VirtualHub 的地址前缀。

返回： 始终

示例： "10.0.0.0/24"

azure_firewall

复杂

与此 VirtualHub 关联的 azureFirewall。

返回： 始终

id

字符串

资源 ID。

返回： 始终

bgp_connections

列表 / 元素=字符串

对 Bgp 连接的引用列表。

返回： 始终

id

字符串

资源 ID。

返回： 始终

enable_virtual_router_route_propogation

布尔值

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

返回： 始终

etag

字符串

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

返回： 始终

示例： "4462b9db-6569-49be-8d00-000178b29e90"

express_route_gateway

复杂

与此 VirtualHub 关联的 expressRouteGateway。

返回： 始终

id

字符串

资源 ID。

返回： 始终

id

字符串

资源 ID。

返回： 始终

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

ip_configurations

列表 / 元素=字符串

对 IpConfigurations 的引用列表。

返回： 始终

id

字符串

资源 ID。

返回： 始终

location

字符串

资源位置。

返回： 始终

示例： "eastus"

name

字符串

资源名称。

返回： 始终

示例： "fredhub"

字符串

如果有，则获取下一组操作列表结果的 URL。

返回： 始终

p2_s_vpn_gateway

复杂

与此 VirtualHub 关联的 P2SVpnGateway。

返回： 始终

id

字符串

资源 ID。

返回： 始终

provisioning_state

字符串

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

返回： 始终

示例： "Succeeded"

route_table

复杂

与此虚拟中心关联的 routeTable。

返回： 始终

routes

列表 / 元素=字符串

所有路由的列表。

返回： 始终

address_prefixes

列表 / 元素=字符串

所有地址前缀的列表。

返回： 始终

next_hop_ip_address

字符串

下一跳 IP 地址。

返回： 始终

routing_state

字符串

路由状态。

返回： 始终

security_partner_provider

复杂

与此 VirtualHub 关联的 securityPartnerProvider。

返回： 始终

id

字符串

资源 ID。

返回： 始终

security_provider_name

字符串

安全提供程序名称。

返回： 始终

sku

字符串

此 VirtualHub 的 SKU。

返回： 始终

示例： "Standard"

tags

字典

资源标签。

返回： 始终

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

type

字符串

资源类型。

返回： 始终

示例： "Microsoft.Network/virtualHubs"

value

复杂

VirtualHubs 的列表。

返回： 始终

address_prefix

字符串

此 VirtualHub 的地址前缀。

返回： 始终

azure_firewall

复杂

与此 VirtualHub 关联的 azureFirewall。

返回： 始终

id

字符串

资源 ID。

返回： 始终

bgp_connections

列表 / 元素=字符串

对 Bgp 连接的引用列表。

返回： 始终

id

字符串

资源 ID。

返回： 始终

enable_virtual_router_route_propogation

布尔值

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

返回： 始终

express_route_gateway

复杂

与此 VirtualHub 关联的 expressRouteGateway。

返回： 始终

id

字符串

资源 ID。

返回： 始终

ip_configurations

列表 / 元素=字符串

对 IpConfigurations 的引用列表。

返回： 始终

id

字符串

资源 ID。

返回： 始终

p2_s_vpn_gateway

复杂

与此 VirtualHub 关联的 P2SVpnGateway。

返回： 始终

id

字符串

资源 ID。

返回： 始终

route_table

复杂

与此虚拟中心关联的 routeTable。

返回： 始终

routes

列表 / 元素=字符串

所有路由的列表。

返回： 始终

address_prefixes

列表 / 元素=字符串

所有地址前缀的列表。

返回： 始终

next_hop_ip_address

字符串

下一跳 IP 地址。

返回： 始终

security_partner_provider

复杂

与此 VirtualHub 关联的 securityPartnerProvider。

返回： 始终

id

字符串

资源 ID。

返回： 始终

security_provider_name

字符串

安全提供程序名称。

返回： 始终

sku

字符串

此 VirtualHub 的 SKU。

返回： 始终

virtual_hub_route_table_v2_s

复杂

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

返回： 始终

attached_connections

列表 / 元素=字符串

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

返回： 始终

name

字符串

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

此名称可用于访问资源。

返回： 始终

routes

列表 / 元素=字符串

所有路由的列表。

返回： 始终

destination_type

字符串

目标的类型。

返回： 始终

destinations

列表 / 元素=字符串

所有目标的列表。

返回： 始终

next_hop_type

字符串

下一跳的类型。

返回： 始终

next_hops

列表 / 元素=字符串

下一跳 IP 地址。

返回： 始终

virtual_router_asn

整数

VirtualRouter ASN。

返回： 始终

virtual_router_ips

列表 / 元素=字符串

VirtualRouter IP。

返回： 始终

virtual_wan

复杂

VirtualHub 所属的 VirtualWAN。

返回： 始终

id

字符串

资源 ID。

返回： 始终

vpn_gateway

复杂

与此 VirtualHub 关联的 VpnGateway。

返回： 始终

id

字符串

资源 ID。

返回： 始终

virtual_hub_route_table_v2_s

复杂

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

返回： 始终

attached_connections

列表 / 元素=字符串

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

返回： 始终

name

字符串

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

此名称可用于访问资源。

返回： 始终

routes

复杂

所有路由的列表。

返回： 始终

destination_type

字符串

目标的类型。

返回： 始终

destinations

列表 / 元素=字符串

所有目标的列表。

返回： 始终

next_hop_type

字符串

下一跳的类型。

返回： 始终

next_hops

列表 / 元素=字符串

下一跳 IP 地址。

返回： 始终

virtual_router_asn

整数

VirtualRouter ASN。

返回： 始终

virtual_router_ips

列表 / 元素=字符串

VirtualRouter IP。

返回： 始终

virtual_wan

复杂

VirtualHub 所属的 VirtualWAN。

返回： 始终

id

字符串

资源 ID。

返回： 始终

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

vpn_gateway

复杂

与此 VirtualHub 关联的 VpnGateway。

返回： 始终

id

字符串

资源 ID。

返回： 始终

作者

  • Fred-Sun (@Fred-Sun)

  • Haiyuan Zhang (@haiyuazhang)