azure.azcollection.azure_rm_loadbalancer 模块 – 管理 Azure 负载均衡器

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 创建、更新和删除 Azure 负载均衡器。

要求

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

  • python >= 2.7

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

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

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

append_tags

布尔值

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

当为规范的时，在 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（如果该资源被授予访问多个订阅的权限），否则将选择第一个订阅。

msi 在 Ansible 2.6 中添加。

选项

  • "auto" ← (默认)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

backend_address_pools

列表 / 元素=字典

后端地址池列表。

name

字符串 / 必需

后端地址池的名称。

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

frontend_ip_configurations

列表 / 元素=字典

要使用的前端 IP 列表。

name

字符串 / 必需

前端 IP 配置的名称。

private_ip_address

字符串

公共 IP 资源的引用。

private_ip_allocation_method

字符串

私有 IP 分配方法。

选项

  • "Static"

  • "Dynamic"

public_ip_address

字符串

当前资源组中要与安全组关联的现有公共 IP 地址对象的名称。

subnet

字符串

子网资源的引用。

应为现有子网的资源 ID。

zones

list / elements=string

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

在设置区域时，必须指定 sku=Standard 和 subnet。

inbound_nat_pools

列表 / 元素=字典

为负载均衡器关联的网卡上的单个后端端口定义入站 NAT 的外部端口范围。

使用此范围内的外部端口为与负载均衡器关联的每个网卡自动创建入站 NAT 规则。

在负载均衡器上定义入站 NAT 池与定义入站 NAT 规则是互斥的。

入站 NAT 池是从虚拟机规模集引用的。

与单个虚拟机关联的网卡不能引用入站 NAT 池。

它们必须引用单独的入站 NAT 规则。

backend_port

integer / required

用于端点内部连接的端口。

可接受的值介于 1 和 65535 之间。

frontend_ip_configuration_name

字符串 / 必需

对前端 IP 地址的引用。

frontend_port_range_end

integer / required

将用于为与负载均衡器关联的网卡提供入站 NAT 的外部端口范围中的最后一个端口。

可接受的值范围介于 1 和 65535 之间。

frontend_port_range_start

integer / required

将用于为与负载均衡器关联的网卡提供入站 NAT 的外部端口范围中的第一个端口。

可接受的值范围介于 1 和 65534 之间。

name

字符串 / 必需

入站 NAT 池的名称。

protocol

字符串

NAT 池的 IP 协议。

选项

  • "Tcp"

  • "Udp"

  • "All"

inbound_nat_rules

列表 / 元素=字典

负载均衡器使用的入站 NAT 规则的集合。

在负载均衡器上定义入站 NAT 规则与定义入站 NAT 池是互斥的。

入站 NAT 池是从虚拟机规模集引用的。

与单个虚拟机关联的网卡不能引用入站 NAT 池。

它们必须引用单独的入站 NAT 规则。

backend_port

integer / required

用于端点内部连接的端口。

可接受的值介于 0 和 65535 之间。

请注意，值 0 启用“任何端口”。

enable_floating_ip

布尔值

为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的端点。

在 SQL Server 中使用 SQL AlwaysOn 可用性组时，此设置是必需的。

创建端点后，无法更改此设置。

选项

  • false

  • true

enable_tcp_reset

布尔值

在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。

仅当 protocol=Tcp 时才使用此元素。

选项

  • false

  • true

frontend_ip_configuration

字符串 / 必需

对前端 IP 地址的引用。

frontend_port

integer / required

外部端点的端口。

前端端口号在负载均衡器的所有规则中必须是唯一的。

可接受的值介于 0 和 65534 之间。

请注意，值 0 启用“任何端口”。

idle_timeout

integer

TCP 空闲连接的超时时间。

该值可以设置为 4 到 30 分钟之间。

默认值为 4 分钟。

仅当 protocol=Tcp 时才使用此元素。

name

字符串 / 必需

入站 NAT 规则的名称。

protocol

字符串

入站 NAT 规则的 IP 协议。

选项

  • "Tcp"

  • "Udp"

  • "All"

load_balancing_rules

列表 / 元素=字典

表示负载均衡规则的对象集合。获取预配状态。

backend_address_pool

字符串 / 必需

对 DIP 池的引用。入站流量在后端 IP 中的 IP 之间随机负载均衡。

backend_port

integer

用于端点内部连接的端口。

可接受的值介于 0 和 65535 之间。

请注意，值 0 启用“任何端口”。

disable_outbound_snat

布尔值

配置出站源网络地址转换 (SNAT)。

省略时的默认行为等同于 disable_outbound_snat=True。

True 等同于门户中的“（推荐）使用出站规则为后端池成员提供 Internet 访问权限”。

False 等同于门户中的“使用默认出站访问权限”。

选项

  • false ← (默认)

  • true

enable_floating_ip

布尔值

为配置 SQL AlwaysOn 可用性组所需的浮动 IP 功能配置虚拟机的端点。

选项

  • false

  • true

frontend_ip_configuration

字符串 / 必需

对前端 IP 地址的引用。

frontend_port

integer / required

外部端点的端口。

前端端口号在负载均衡器的所有规则中必须是唯一的。

可接受的值介于 0 和 65534 之间。

请注意，值 0 启用“任何端口”。

idle_timeout

integer

TCP 空闲连接的超时时间。

该值可以设置为 4 到 30 分钟之间。

默认值为 4 分钟。

仅当协议设置为 TCP 时才使用此元素。

默认值: 4

load_distribution

字符串

此规则的会话持久性策略；Default 表示没有持久性。

选项

  • "Default" ← (默认)

  • "SourceIP"

  • "SourceIPProtocol"

name

字符串 / 必需

负载均衡规则的名称。

probe

字符串 / 必需

此规则应用于运行状况检查的负载均衡器探测的名称。

protocol

字符串

负载均衡规则的 IP 协议。

选项

  • "Tcp"

  • "Udp"

  • "All"

location

字符串

有效的 Azure 位置。默认为资源组的位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必需

负载均衡器的名称。

password

字符串

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

probes

列表 / 元素=字典

用于检查端点运行状况的探测定义列表。

fail_count

别名：number_of_probes

integer

如果没有任何响应，将导致停止向端点传递进一步流量的探测次数。

此值允许端点比 Azure 中使用的典型时间更快或更慢地退出轮换。

默认值: 3

interval

integer

以秒为单位，探测端点运行状况状态的频率间隔。

略小于分配的超时时间的一半，这允许在将实例从轮换中移除之前进行两次完整的探测。

默认值为 15，最小值为 5。

默认值: 15

name

字符串 / 必需

探测的名称。

port

integer / required

用于通信探测的探测端口。可能的值范围从 1 到 65535，包括 1 和 65535。

protocol

字符串

要探测的端点的协议。

如果指定了 Tcp，则需要收到 ACK 才能使探测成功。

如果指定了 Http 或 Https，则需要从指定的 URL 返回 200 OK 响应才能使探测成功。

选项

  • "Tcp"

  • "Http"

  • "Https"

request_path

字符串

用于从 VM 请求运行状况状态的 URI。

如果 protocol=Http 或 protocol=Https，则需要 Path。否则，不允许使用。

profile

字符串

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

resource_group

字符串 / 必需

负载均衡器存在或将要创建的资源组的名称。

secret

字符串

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

sku

字符串

负载均衡器 SKU。

选项

  • "Basic"

  • "Standard"

state

字符串

断言负载均衡器的状态。使用 present 创建/更新负载均衡器，或使用 absent 删除负载均衡器。

选项

  • "absent"

  • "present" ← (默认)

subscription_id

字符串

您的 Azure 订阅 ID。

tags

dictionary

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

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

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

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

Azure Front Door 不支持使用

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

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 版本中添加

x509_certificate_path 中指定的私钥的指纹。

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

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

x509_certificate_path

path

在 azure.azcollection 1.14.0 版本中添加

用于以 PEM 格式创建服务主体的 X509 证书的路径。

证书必须附加到私钥。

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

注释

注意

  • 要使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在使用 az login 命令运行任务或 playbook 之前登录。

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: create load balancer
  azure_rm_loadbalancer:
    resource_group: myResourceGroup
    name: testloadbalancer1
    frontend_ip_configurations:
      - name: frontendipconf0
        public_ip_address: testpip
    backend_address_pools:
      - name: backendaddrpool0
    probes:
      - name: prob0
        port: 80
    inbound_nat_pools:
      - name: inboundnatpool0
        frontend_ip_configuration_name: frontendipconf0
        protocol: Tcp
        frontend_port_range_start: 80
        frontend_port_range_end: 81
        backend_port: 8080
    load_balancing_rules:
      - name: lbrbalancingrule0
        frontend_ip_configuration: frontendipconf0
        backend_address_pool: backendaddrpool0
        frontend_port: 80
        backend_port: 80
        probe: prob0
    inbound_nat_rules:
      - name: inboundnatrule0
        backend_port: 8080
        protocol: Tcp
        frontend_port: 8080
        frontend_ip_configuration: frontendipconf0

返回值

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

键

描述

changed

布尔值

资源是否已更改。

返回: 始终

state

dictionary

负载均衡器的当前状态。

返回: 始终

作者

  • Thomas Stringer (@trstringer)

  • Yuwei Zhou (@yuwzho)