azure.azcollection.azure_rm_ipgroup 模块 – 创建、删除和更新 IP 组

注意

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

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

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

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

azure.azcollection 1.6.0 中的新增功能

概要

  • 在指定的资源组中创建、删除和更新 IP 组。

要求

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

  • python >= 2.7

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

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

  • 完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到

参数

参数

注释

ad_user

string

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

adfs_authority_url

string

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且有自己的 ADFS 授权时使用。

api_profile

string

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公共云；未来的值将允许与 Azure Stack 一起使用。

默认值： "latest"

append_tags

boolean

用于控制 tags 字段是规范的还是仅附加到现有标签。

当为规范时，tags 参数中未找到的任何标签将从对象的元数据中删除。

选择

  • false

  • true ← (默认值)

auth_source

string

在 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，如果存在多个订阅 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

string

在 azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理时，或者针对 Azure Stack，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选择

  • "ignore"

  • "validate"

client_id

string

Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

string

在 azure.azcollection 0.0.1 中添加

对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如，AzureChinaCloud、AzureUSGovernment），或元数据发现终结点 URL（Azure Stack 所必需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

disable_instance_discovery

boolean

在 azure.azcollection 2.3.0 中添加

确定在尝试身份验证时是否执行实例发现。将此设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据终结点的情况，例如在私有云或 Azure Stack 中。实例发现的过程需要从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此设置为 **True**，将禁用授权验证。因此，至关重要的是确保配置的授权主机有效且可信。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选择

  • false ← (默认值)

  • true

ip_addresses

list / elements=string

IP 组中的 IP 地址列表。

location

string

IP 组的位置。如果未指定，则默认为资源组的位置。

log_mode

string

父参数。

log_path

string

父参数。

name

字符串 / 必填

IP 组的名称。

密码

string

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

配置文件

string

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

资源组

字符串 / 必填

资源组的名称。

密钥

string

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

状态

string

断言 IP 组的状态。使用 present 来创建或更新，使用 absent 来删除。

选择

  • "absent"

  • "present" ← (默认)

订阅 ID

string

您的 Azure 订阅 ID。

标签

字典

要作为元数据分配给对象的字符串:字符串对的字典。

对象上的元数据标签将使用任何提供的值进行更新。

要删除标签，请将 append_tags 选项设置为 false。

目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。

Azure Front Door 不支持使用

Azure Automation 和 Azure CDN 仅支持资源上的 15 个标签。

租户

string

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

指纹

string

在 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: Create IP Group
  azure_rm_ipgroup:
    resource_group: MyAzureResourceGroup
    name: myipgroup
    location: eastus
    ip_addresses:
      - 13.64.39.16/32
      - 40.74.146.80/31
      - 40.74.147.32/28
    tags:
      key1: "value1"
    state: present

- name: Update IP Group
  azure_rm_ipgroup:
    resource_group: MyAzureResourceGroup
    name: myipgroup
    location: eastus
    ip_addresses:
      - 10.0.0.0/24
    tags:
      key2: "value2"

- name: Delete IP Group
  azure_rm_ipgroup:
    resource_group: MyAzureResourceGroup
    name: myipgroup
    state: absent

返回值

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

键

描述

状态

复合

IP 组的当前状态。

返回： 总是

etag

string

IP 组的 etag。

返回： 总是

示例： "c67388ea-6dab-481b-9387-bd441c0d32f8"

防火墙

列表 / 元素=字典

此 IpGroups 与之关联的防火墙资源引用列表。

返回： 总是

示例： [{"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/providers/ Microsoft.Network/azureFirewalls/azurefirewall"}]

ID

string

IP 组 ID。

返回： 总是

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/MyAzureResourceGroup/providers/ Microsoft.Network/ipGroups/myipgroup"

ip_addresses

list / elements=string

IP 组中的 IP 地址列表。

返回： 总是

示例： ["13.64.39.16/32", "40.74.146.80/31", "40.74.147.32/28"]

location

string

资源所在的 Azure 区域。

返回： 总是

示例： "eastus"

name

string

IP 组名称。

返回： 总是

示例： "myipgroup"

预配状态

string

资源的预配状态。

返回： 总是

示例： "Succeeded"

标签

list / elements=string

资源标签。

返回： 总是

示例： [{"key1": "value1"}]

类型

string

资源的类型。

返回： 总是

示例： "Microsoft.Network/IpGroups"

作者

  • Aparna Patil (@techcon65)