azure.azcollection.azure_rm_publicipaddress 模块 – 管理 Azure 公共 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。

azure.azcollection 0.1.0 中的新增功能

概要

• 创建、更新和删除公共 IP 地址。

• 允许设置和更新地址分配方法和域名标签。

• 使用 azure.azcollection.azure_rm_networkinterface 模块将公共 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 授权。
allocation_method 字符串	控制分配的公共 IP 是否永久分配给对象。 如果未设置为 Static，则关联的虚拟机每次电源循环时 IP 地址都可能发生更改。 选项 "dynamic" ← (默认) "static" "Static" "Dynamic"
api_profile 字符串 azure.azcollection 0.0.1 中添加	选择与 Azure 服务通信时要使用的 API 配置文件。对于公共云，latest 的默认值是合适的；未来的值将允许与 Azure Stack 一起使用。 默认： "latest"
append_tags 布尔值	用于控制标签字段是规范的还是只是附加到现有标签。 规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项 false true ← (默认)
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
domain_name 别名：domain_name_label 字符串	分配给公共 IP 地址的 FQDN 的可自定义部分。这是一个显式设置。 如果未提供值，则将在现有公共 IP 上删除任何现有值。
idle_timeout 整数	空闲超时（分钟）。
ip_tags 列表 / 元素=字典	与公共 IP 地址关联的 IpTag 列表。 每个元素应包含键值对。
type 字符串 / 必需	设置 ip_tags 类型。
value 字符串 / 必需	设置 ip_tags 值。
location 字符串	有效的 Azure 位置。默认为资源组的位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必需	公共 IP 的名称。
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	与公共 IP 关联的资源组的名称。
reverse_fqdn 字符串	反向 FQDN。 解析到此公共 IP 地址的用户可见完全限定域名。 如果指定了 reverseFqdn，则会创建一个 PTR DNS 记录，该记录指向 in-addr.arpa 域中 IP 地址的反向 FQDN。
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
sku 字符串	公共 IP 地址 SKU。 当 version=ipv6 时，如果 sku=standard，则设置 allocation_method=static。 当 version=ipv4 时，如果 sku=standard，则设置 allocation_method=static。 选项 “basic” “standard” “Basic” “Standard”
state 字符串	声明公共 IP 的状态。使用 present 创建或更新，使用 absent 删除。 选项 “absent” "present" ← (默认)
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的字符串：字符串对字典。 对象的元数据标签将使用任何提供的数值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 资源上只支持 15 个标签。
tenant 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
thumbprint 字符串 azure.azcollection 1.14.0 版本中添加	x509_certificate_path 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
version 字符串	公共 IP 地址版本。 选项 "ipv4" ← (默认) “ipv6”
x509_certificate_path 路径 azure.azcollection 1.14.0 版本中添加	PEM 格式的服务主体使用的 X509 证书的路径。 证书必须附加到私钥。 使用服务主体进行身份验证时使用。
zones 列表 / 元素=字符串	表示需要从中分配资源的 IP 的可用性区域列表。 选项 "1" "2" "3"

注释

注意

• 对于使用 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: Create a public ip address
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    allocation_method: static
    domain_name: foobar

- name: Delete public ip
  azure_rm_publicipaddress:
    resource_group: myResourceGroup
    name: my_public_ip
    state: absent

返回值

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

键	描述
state 复杂	关于对象当前状态的事实。 返回：始终
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'"
idle_timeout_in_minutes 整数	公共 IP 地址的空闲超时。 返回：始终 示例： 4
ip_address 字符串	应从中分配此公共 IP 地址的公共 IP 前缀。 返回：始终 示例： "52.160.103.93"
location 字符串	资源位置。 返回：始终 示例： "eastus"
name 字符串	公共 IP 地址的名称。 返回：始终 示例： "publicip002"
provisioning_state 字符串	公共 IP 资源的预配状态。 返回：始终 示例： "Succeeded"
public_ip_address_version 字符串	公共 IP 地址版本。 返回：始终 示例： "ipv4"
public_ip_allocation_method 字符串	公共 IP 分配方法。 返回：始终 示例： "static"
sku 字符串	公共 IP 地址 SKU。 返回：始终 示例： "Basic"
tags 字典	资源标签。 返回：始终 示例： {"delete": "on-exit", "testing": "testing"}
type 字符串	资源类型。 返回：始终 示例： "Microsoft.Network/publicIPAddresses"
zones 列表 / 元素=字符串	表示需要从中分配资源的 IP 的可用性区域列表。 返回：始终 示例： ["1", "2"]

作者

• Chris Houseknecht (@chouseknecht)

• Matt Davis (@nitzmahone)

收藏链接

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