azure.azcollection.azure_rm_publicipprefix_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_publicipprefix_info

azure.azcollection 2.2.0 中的新增功能

概要

  • 获取特定公共 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 定义,例如 AzureChinaCloudAzureUSGovernment)或元数据发现端点 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 Prefix
  azure_rm_publicipprefix_info:
    resource_group: myResourceGroup
    name: publicipprefix

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

返回值

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

描述

publicipprefix

复杂类型

公有 IP 前缀字典列表。

返回: 始终

custom_ip_prefix

字典

此前缀关联的 customIpPrefix。

返回: 始终

示例: {}

etag

字符串

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

返回: 始终

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

extended_location

字符串

公有 IP 地址的扩展位置。

返回: 始终

示例: "eastus2"

id

字符串

资源 ID。

返回: 始终

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

ip_prefix

字符串

分配的前缀。

返回: 成功

示例: "20.199.95.80/29"

ip_tags

列表 / 元素=字符串

与公有 IP 前缀关联的标签列表。

返回: 始终

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

location

字符串

资源位置。

返回: 始终

示例: "eastus"

name

字符串

公有 IP 前缀的名称。

返回: 始终

示例: "prefix57dc95224"

prefix_length

整数

公有 IP 前缀的长度。

返回: 始终

示例: 29

provisioning_state

字符串

PublicIP Prefix 资源的预配状态。

可能的值为 Succeeded

返回: 始终

示例: "Succeeded"

public_ip_address_version

字符串

公有 IP 地址版本。

可能的值为 IPv4IPv6

返回: 始终

示例: "IPv4"

public_ip_addresses

列表 / 元素=字符串

所有引用的 PublicIPAddresses 列表。

返回: 成功

示例: []

resource_guid

字符串

公有 IP 前缀资源的资源 GUID 属性。

返回: 成功

示例: "47cafa04-851d-4579-894d-74ad6afe3233"

sku

字典

公有 IP 前缀 SKU。

返回: 始终

示例: {"name": "standard", "tier": "Regional"}

tags

字典

资源标签。

返回: 始终

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

type

字符串

资源类型。

返回: 始终

示例: "Microsoft.Network/publicIPPrefixes"

zones

列表 / 元素=字符串

表示资源所需 IP 地址来源的可用区列表。

返回: 始终

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

作者

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)