azure.azcollection.azure_rm_publicipaddress_info 模块 – 获取公网 IP 信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

摘要

  • 获取特定公网 IP 或资源组中所有公网 IP 的信息。

要求

以下是执行此模块的主机所需的条件。

  • 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，如果资源被授予对多个订阅的访问权限，否则选择第一个订阅。

Ansible 2.6 中添加了 msi。

选项

  • "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

字符串

仅显示特定公网 IP 的结果。

password

字符串

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

profile

字符串

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

resource_group

字符串

按资源组限制结果。使用 name 参数时必填。

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tags

列表 / 元素=字符串

通过提供标签列表来限制结果。格式标签为“键”或“键:值”。

tenant

字符串

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

thumbprint

字符串

azure.azcollection 1.14.0 中添加

在x509_certificate_path中指定的私钥的指纹。

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

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

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 和 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 for one Public IP
  azure_rm_publicipaddress_info:
    resource_group: myResourceGroup
    name: publicip001

- name: Get facts for all Public IPs within a resource groups
  azure_rm_publicipaddress_info:
    resource_group: myResourceGroup
    tags:
      - key:value

返回值

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

键

描述

azure_publicipaddresses

列表 / 元素=字符串

公网 IP 地址字典列表。

请注意，此选项将在 2.10 版中弃用，届时已整理的格式将成为唯一受支持的格式。

返回：始终

示例：[{"etag": "W/\"a31a6d7d-cb18-40a5-b16d-9f4a36c1b18a\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/pip2001", "location": "eastus2", "name": "pip2001", "properties": {"idleTimeoutInMinutes": 4, "provisioningState": "Succeeded", "publicIPAllocationMethod": "Dynamic", "resourceGuid": "29de82f4-a7da-440e-bd3d-9cabb79af95a"}, "type": "Microsoft.Network/publicIPAddresses"}]

publicipaddresses

复杂

公网 IP 地址列表。

包含与 azure_rm_publicipaddress 参数匹配的详细信息。

当 format 参数设置为 curated 时返回。

返回：始终

allocation_method

字符串

公网 IP 分配方法。

可能的值为static和dynamic。

返回：始终

示例："static"

dns_settings

字典

与公网 IP 地址关联的 DNS 记录的 FQDN。

返回：始终

示例：{"domain_name_label": "ansible-b57dc95985712e45eb8b9c2e", "fqdn": "ansible-b57dc95985712e45eb8b9c2e.eastus.cloudapp.azure.com", "reverse_fqdn": "ansible-b57dc95985712e45eb8b9c2f.eastus.cloudapp.azure.com"}

etag

字符串

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

返回：始终

示例："W/'1905ee13-7623-45b1-bc6b-4a12b2fb9d15'"

id

字符串

资源 ID。

返回：始终

示例："/subscriptions/xxx---xxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/publicIPAddresses/pipb57dc95224"

idle_timeout

整数

公网 IP 地址的空闲超时。

返回：始终

示例：4

ip_address

字符串

此公网 IP 地址应从中分配的公网 IP 前缀。

返回：始终

示例："40.121.144.14"

ip_tags

列表 / 元素=字符串

与公网 IP 地址关联的标签列表。

返回：始终

示例：[{"type": "FirstPartyUsage", "value": "Storage"}]

location

字符串

资源位置。

返回：始终

示例："eastus"

name

字符串

公网 IP 地址的名称。

返回：始终

示例："pipb57dc95224"

provisioning_state

字符串

PublicIP 资源的预配状态。

可能的值为Succeeded。

返回：始终

示例："Succeeded"

sku

字符串

公网 IP 地址 SKU。

返回：始终

示例："Basic"

tags

字典

资源标签。

返回：始终

示例：{"delete": "on-exit", "testing": "testing"}

type

字符串

资源类型。

返回：始终

示例："Microsoft.Network/publicIPAddresses"

version

字符串

公网 IP 地址版本。

可能的值为ipv4和ipv6。

返回：始终

示例："ipv4"

zones

列表 / 元素=字符串

表示需要为此资源分配 IP 的可用性区域的列表。

返回：始终

示例：["1", "2"]

作者

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)