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

注意

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

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

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

要在剧本中使用它，请指定：azure.azcollection.azure_rm_virtualhubconnection。

azure.azcollection 1.14.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 用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串 在 azure.azcollection 0.0.1 中添加	Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且具有您自己的 ADFS 授权时使用。
allow_hub_to_remote_vnet_transit 布尔值	VirtualHub 到 RemoteVnet 的传输是否启用。 选择 false true
allow_remote_vnet_to_use_hub_vnet_gateways 布尔值	允许 RemoteVnet 使用 Virtual Hub 的网关。 选择 false true
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（如果存在多个），否则使用默认的 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
enable_internet_security 布尔值	启用 Internet 安全性。 选择 false true
log_mode 字符串	父参数。
log_path 字符串	父参数。
name string / 必填	VirtualHub 连接的名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
remote_virtual_network 字典	要连接的远程 VNet 的 ID。
id 字符串	远程虚拟网络的 ID。
resource_group string / 必填	VirtualHub 的资源组名称。
routing_configuration 字典	路由配置，指示此连接上关联和传播的路由表。
propagated_route_tables 字典	要将路由通告到的路由表列表。
ids list / elements=dictionary	- 所有虚拟中心路由表的资源 ID 列表。
id 字符串	路由表的 ID。
labels list / elements=string	标签列表。
vnet_routes 字典	控制从 VirtualHub 到虚拟网络连接的路由的路由列表。
static_routes list / elements=dictionary	所有静态路由的列表。
address_prefixes list / elements=string	所有地址前缀的列表。
name 字符串	静态路由的名称，该名称在 VnetRoute 中是唯一的。
next_hop_ip_address 字符串	下一跳的 IP 地址。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
state 字符串	断言 VirtualHub 连接的状态。 使用 present 创建或更新 VirtualHub 连接，使用 absent 删除它。 选择 "absent" "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需项。
vhub_name string / 必填	VirtualHub 名称。
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。也可以添加其他配置文件。通过传递配置文件或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create virtual hub connection
  azure_rm_virtualhubconnection:
    resource_group: myRG
    vhub_name: testhub
    name: Myconnection
    enable_internet_security: false
    allow_remote_vnet_to_use_hub_vnet_gateways: true
    allow_hub_to_remote_vnet_transit: true
    remote_virtual_network:
      id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet
    routing_configuration:
      propagated_route_tables:
        labels:
          - labels1
          - labels3
        ids:
          - id: /subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub01/hubRouteTables/testtable
      vnet_routes:
        static_routes:
          - name: route1
            address_prefixes:
              - 10.1.0.0/16
              - 10.2.0.0/16
            next_hop_ip_address: 10.0.0.68
          - name: route2
            address_prefixes:
              - 10.4.0.0/16
            next_hop_ip_address: 10.0.0.65

- name: Delete virtual hub connection
  azure_rm_virtualhubconnection:
    resource_group: myRG
    vhub_name: testhub
    name: Myconnection
    state: absent

返回值

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

Key	描述
state complex	虚拟中心连接信息的字典结果列表。 返回: 总是
allow_hub_to_remote_vnet_transit 布尔值	启用中心到远程 VNet 的传输。 返回: 总是 示例: true
allow_remote_vnet_to_use_hub_vnet_gateways 布尔值	允许远程 VNet 使用中心的 VNet 网关。 返回: 总是 示例: true
enable_internet_security 布尔值	启用 Internet 安全性，默认情况下已启用。 返回: 总是 示例: true
etag 字符串	一个唯一的只读字符串，每次资源更新时都会更改。 返回: 总是 示例: "31102041-49e7-4cac-8573-aac1e1a16793"
id 字符串	资源 ID。 返回: 总是 示例: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/vhub/hubVirtualNetworkConnections/MyConnection"
name 字符串	资源名称。 返回: 总是 示例: "MyConnection"
provisioning_state 字符串	虚拟中心连接资源的预配状态。 返回: 总是 示例: "Succeeded"
remote_virtual_network complex	要连接的远程 VNet 的 ID 或名称。 返回: 总是
id 字符串	要连接的远程 VNet 的 ID。 返回: 总是 示例: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/testvnet"
routing_configuration complex	路由配置信息 返回: 总是
associated_route_table complex	与此路由配置关联的路由表的资源 ID。 返回: 总是
id 字符串	路由表的 ID。 返回: 总是 示例: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name"
propagated_route_tables complex	以空格分隔的传播路由表的资源 ID 列表。 返回: 总是
ids list / elements=string	传播路由表的资源 ID 列表。 返回: 总是 示例: [{"id": "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualHubs/testhub/hubRouteTables/rt_name"}]
labels list / elements=string	以空格分隔的传播路由表的标签列表。 返回: 总是 示例: ["labels1", "labels2"]
vnet_routes complex	静态路由的名称，该名称在 Vnet 路由中是唯一的。 返回: 总是
static_routes list / elements=string	静态路由的名称。 返回: 总是
address_prefixes list / elements=string	以空格分隔的所有地址前缀列表。 返回: 总是 示例: ["10.1.0.0/16", "10.2.0.0/16"]
name 字符串	静态路由器的名称。 返回: 总是 示例: "route1"
next_hop_ip_address 字符串	下一跳的 IP 地址。 返回: 总是 示例: "10.0.0.65"

作者

• Fred-Sun (@Fred-Sun)

• 徐张 (@xuzhang3)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）