azure.azcollection.azure_rm_subnet_info 模块 – 获取 Azure 子网信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 获取 Azure 子网信息。

要求

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

  • python >= 2.7

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

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

  • 完整的安装说明可在 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

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

子网名称。

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必需

资源组的名称。

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

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

指纹

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

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

如果定义了x509_certificate_path，则需要此参数。

虚拟网络名称

字符串 / 必需

虚拟网络的名称。

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get facts of specific subnet
  azure_rm_subnet_info:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet

- name: List facts for all subnets in virtual network
  azure_rm_subnet_info:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet

返回值

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

键

描述

子网

复杂

包含子网信息的字典列表。

返回：始终

address_prefix_cidr

字符串

定义子网 IPv4 地址空间的 CIDR。

返回：始终

示例： "10.1.0.0/16"

address_prefixes_cidr

列表 / 元素=字符串

定义子网 IPv4 和 IPv6 地址空间的 CIDR。

返回：始终

示例： ["10.2.0.0/24", "fdda:e69b:1587:495e::/64"]

委派

列表 / 元素=字符串

关联的子网委派

返回：始终

操作

列表 / 元素=字符串

与委派服务关联的操作列表

返回：当存在委派时

示例： ["Microsoft.Network/virtualNetworks/subnets/action"]

name

字符串

委派名称

返回：当存在委派时

示例： "delegationname"

配置状态

字符串

委派的配置状态。

返回：当存在委派时

示例： "Succeeded"

serviceName

字符串

与委派关联的服务

返回：当存在委派时

示例： "Microsoft.ContainerInstance/containerGroups"

ID

字符串

子网资源 ID。

返回：始终

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/my VirtualNetwork/subnets/mySubnet"

name

字符串

子网名称。

返回：始终

示例： "mySubnet"

nat_gateway

字符串

关联的 NAT 网关的 ID。

返回：当可用时

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

private_endpoint_network_policies

字符串

Enabled 或 Disabled 在子网中的专用端点上应用网络策略。

返回：始终

示例： "Enabled"

字符串

Enabled 或 Disabled 在子网中的专用链接服务上应用网络策略。

返回：始终

示例： "Disabled"

配置状态

字符串

配置状态。

返回：始终

示例： "Succeeded"

resource_group

字符串

资源组名称。

返回：始终

示例： "myResourceGroup"

route_table

字符串

关联的路由表 ID。

返回：始终

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

安全组

字符串

关联的安全组 ID。

返回：始终

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGr oups/myNsg"

service_endpoints

列表 / 元素=字符串

服务端点列表。

返回：当可用时

位置

列表 / 元素=字符串

位置名称列表。

返回：始终

示例： ["eastus", "westus"]

配置状态

字符串

配置状态。

返回：始终

示例： "Succeeded"

服务

字符串

端点服务的类型。

返回：始终

示例： "Microsoft.Sql"

虚拟网络名称

字符串

包含虚拟网络的名称。

返回：始终

示例： "myVirtualNetwork"

作者

  • Zim Kalinowski (@zikalino)