azure.azcollection.azure_rm_virtualnetwork_info 模块 – 获取虚拟网络信息

注意

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

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

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

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

azure.azcollection 0.0.1 中的新增功能

概要

  • 获取特定虚拟网络或资源组内所有虚拟网络的信息。

要求

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

  • 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，如果存在多个订阅，则使用默认的 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

list_usage

布尔值

是否列出使用统计信息。list_usage=true 列出使用统计信息。

选择

  • false ← (默认)

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

仅显示特定虚拟网络的结果。

password

字符串

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

profile

字符串

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

resource_group

字符串

按资源组限制结果。当按名称筛选时是必需的。

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tags

list / elements=string

通过提供标签列表来限制结果。将标签格式化为 ‘key’ 或 ‘key:value’。

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 中的配置文件，或者在运行任务或 playbook 之前使用 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 facts for one virtual network
  azure_rm_virtualnetwork_info:
    resource_group: myResourceGroup
    name: secgroup001

- name: Get facts for all virtual networks
  azure_rm_virtualnetwork_info:
    resource_group: myResourceGroup

- name: Get facts by tags
  azure_rm_virtualnetwork_info:
    tags:
      - testing

返回值

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

键

描述

azure_virtualnetworks

list / elements=string

虚拟网络字典的列表。

返回： 总是

示例： [{"etag": "W/\"532ba1be-ae71-40f2-9232-3b1d9cf5e37e\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet2001", "location": "eastus2", "name": "vnet2001", "properties": {"addressSpace": {"addressPrefixes": ["10.10.0.0/16"]}, "provisioningState": "Succeeded", "resourceGuid": "a7ba285f-f7e7-4e17-992a-de4d39f28612", "subnets": []}, "type": "Microsoft.Network/virtualNetworks"}]

virtualnetworks

复杂

虚拟网络字典列表，格式与 azure.azcollection.azure_rm_virtualnetwork 模块参数相同。

返回： 总是

address_prefixes

list / elements=string

IPv4 地址范围的列表，每个范围都使用 CIDR 表示法格式化。

返回： 总是

示例： ["10.10.0.0/16"]

dns_servers

list / elements=string

DNS 服务器的自定义列表。

返回： 总是

示例： ["www.azure.com"]

flow_timeout_in_minutes

整数

虚拟网络的 FlowTimeout 值（以分钟为单位）。

返回： 总是

示例： 8

id

字符串

虚拟网络的资源 ID。

返回： 总是

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet2001"

location

字符串

有效的 Azure 位置。

返回： 总是

示例： "eastus"

name

字符串

虚拟网络的名称。

返回： 总是

示例： "foo"

provisioning_state

字符串

资源的预配状态。

返回： 总是

示例： "Succeeded"

subnets

list / elements=string

与虚拟网络关联的子网。

返回： 总是

address_prefix

字符串

子网的地址前缀。

返回： 总是

示例： "10.1.0.0/16"

address_prefixes

list / elements=string

子网的 IPv4 和 IPv6 地址前缀，如果仅设置了 IPv4，则返回 null。

返回： 总是

示例： ["10.1.0.0/16", "fdda:e69b:2547:485e::/64"]

id

字符串

子网的资源 ID。

返回： 总是

示例： "/subscriptions/f64d4ee8-be94-457d-ba26-3fa6b6506cef/resourceGroups/v-xisuRG/providers/ Microsoft.Network/virtualNetworks/vnetb57dc95232/subnets/vnetb57dc95232"

name

字符串

子网的名称。

返回： 总是

示例： "vnetb57dc95232"

network_security_group

字符串

用于关联子网的现有安全组 ID。

返回： 总是

provisioning_state

字符串

子网的预配状态。

返回： 总是

示例： "Succeeded"

route_table

字符串

RouteTable 资源的引用。

返回： 总是

service_endpoints

list / elements=string

服务终结点的数组。

返回： 总是

示例： [{"locations": ["southeastasia", "eastasia"], "service": "Microsoft.Storage"}]

usages

list / elements=string

列出使用情况统计信息。

返回： 总是

示例： [{"current_value": 0.0, "id": "/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/default", "limit": 251.0, "name": {"localized_value": "子网大小和使用情况", "value": "SubnetSpace"}}]

tags

dictionary

分配给资源的标签。字符串:字符串对的字典。

返回： 总是

示例： {"tag1": "abc"}

作者

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)