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 集合
集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 模块的主机上
完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到
参数
参数 |
注释 |
|---|---|
Active Directory 用户名。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
Azure AD 授权 URL。在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。 |
|
选择与 Azure 服务通信时要使用的 API 配置文件。对于公共云， 默认值： |
|
用于控制标签字段是规范的还是只附加到现有标签。 当规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项
|
|
控制用于身份验证的凭据来源。 也可以通过 当设置为 当设置为 当设置为 当设置为 当设置为
选项
|
|
后端地址池列表。 |
|
后端地址池的名称。 |
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选项
|
|
Azure 客户端 ID。在使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 |
|
对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 默认值： |
|
确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从https://login.microsoft.com/检索权限元数据以验证权限。将其设置为**True**，将禁用权限的验证。因此，务必确保已配置的权限主机有效且可信。 通过凭据文件配置文件或 选项
|
|
要使用的前端 IP 列表。 |
|
前端 IP 配置的名称。 |
|
公共 IP 资源的引用。 |
|
私有 IP 分配方法。 选项
|
|
当前资源组中要与安全组关联的现有公共 IP 地址对象的名称。 |
|
子网资源的引用。 应该是现有子网的资源 ID。 |
|
表示资源分配的 IP 需要来自的可用性区域列表。 设置区域时，必须指定sku=Standard 和subnet。 |
|
为入站 NAT 定义一个外部端口范围，用于连接到与负载均衡器关联的 NIC 上的单个后端端口。 使用此范围内的外部端口，将为与负载均衡器关联的每个 NIC 自动创建入站 NAT 规则。 在负载均衡器上定义入站 NAT 池与定义入站 NAT 规则是互斥的。 入站 NAT 池是从虚拟机规模集引用的。 与单个虚拟机关联的 NIC 无法引用入站 NAT 池。 它们必须引用单个入站 NAT 规则。 |
|
端点上用于内部连接的端口。 可接受的值介于 1 和 65535 之间。 |
|
对前端 IP 地址的引用。 |
|
将用于为与负载均衡器关联的 NIC 提供入站 NAT 的外部端口范围的最后一个端口。 可接受的值范围介于 1 和 65535 之间。 |
|
将用于为与负载均衡器关联的 NIC 提供入站 NAT 的外部端口范围的第一个端口。 可接受的值范围介于 1 和 65534 之间。 |
|
入站 NAT 池的名称。 |
|
NAT 池的 IP 协议。 选项
|
|
负载均衡器使用的入站 NAT 规则集合。 在负载均衡器上定义入站 NAT 规则与定义入站 NAT 池是互斥的。 入站 NAT 池是从虚拟机规模集引用的。 与单个虚拟机关联的 NIC 无法引用入站 NAT 池。 它们必须引用单个入站 NAT 规则。 |
|
端点上用于内部连接的端口。 可接受的值介于 0 和 65535 之间。 请注意，值为 0 表示“任何端口”。 |
|
为虚拟机的端点配置浮动 IP 功能，这是配置 SQL AlwaysOn 可用性组所需的。 在 SQL Server 中使用 SQL AlwaysOn 可用性组时，此设置是必需的。 创建端点后，无法更改此设置。 选项
|
|
在 TCP 流空闲超时或意外连接终止时接收双向 TCP 重置。 仅当protocol=Tcp时才使用此元素。 选项
|
|
对前端 IP 地址的引用。 |
|
外部端点的端口。 前端端口号在负载均衡器内的所有规则中必须唯一。 可接受的值介于 0 和 65534 之间。 请注意，值为 0 表示“任何端口”。 |
|
TCP 空闲连接的超时时间。 该值可以设置为 4 到 30 分钟之间。 默认值为 仅当protocol=Tcp时才使用此元素。 |
|
入站 NAT 规则的名称。 |
|
入站 NAT 规则的 IP 协议。 选项
|
|
表示负载均衡规则的对象集合 获取配置。 |
|
对 DIP 池的引用。入站流量将在后端 IP 中的 IP 之间进行随机负载均衡。 |
|
端点上用于内部连接的端口。 可接受的值介于 0 和 65535 之间。 请注意，值为 0 表示“任何端口”。 |
|
配置出站源网络地址转换 (SNAT)。 省略时，默认行为等效于disable_outbound_snat=True。 True 等效于门户中的“(推荐) 使用出站规则为后端池成员提供对互联网的访问权限”。 False 等效于门户中的“使用默认出站访问”。 选项
|
|
为虚拟机的端点配置浮动 IP 功能，这是配置 SQL AlwaysOn 可用性组所需的。 选项
|
|
对前端 IP 地址的引用。 |
|
外部端点的端口。 前端端口号在负载均衡器内的所有规则中必须唯一。 可接受的值介于 0 和 65534 之间。 请注意，值为 0 表示“任何端口”。 |
|
TCP 空闲连接的超时时间。 该值可以设置为 4 到 30 分钟之间。 默认值为 仅当协议设置为 TCP 时才使用此元素。 默认： |
|
此规则的会话持久性策略； 选项
|
|
负载均衡规则的名称。 |
|
此规则应用于运行状况检查的负载均衡探测器的名称。 |
|
负载均衡规则的 IP 协议。 选项
|
|
有效的 Azure 位置。默认为资源组的位置。 |
|
父参数。 |
|
父参数。 |
|
负载均衡器的名称。 |
|
Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
用于检查端点运行状况的探测器定义列表。 |
|
探测器的数量，如果没有响应，将导致停止将更多流量传递到端点。 此值允许端点比 Azure 中使用的典型时间更快或更慢地退出轮换。 默认： |
|
以秒为单位的间隔，用于多频繁地探测端点的运行状况。 略小于分配的超时期的一半，这允许在将实例移出轮换之前进行两次完整的探测。 默认值为 默认： |
|
探测器的名称。 |
|
用于与探测器通信的探测器端口。可能的值范围为 1 到 65535（包括）。 |
|
要探测的端点的协议。 如果指定 如果指定 选项
|
|
用于从 VM 请求运行状况状态的 URI。 如果protocol=Http或protocol=Https，则需要路径。否则，不允许。 |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
负载均衡器存在或将要创建的资源组的名称。 |
|
Azure 客户端密钥。在使用服务主体进行身份验证时使用。 |
|
负载均衡器 SKU。 选项
|
|
断言负载均衡器的状态。使用 选项
|
|
您的 Azure 订阅 ID。 |
|
字符串：字符串对的字典，作为元数据分配给对象。 对象的元数据标签将使用任何提供的值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 资源上只支持 15 个标签。 |
|
Azure 租户 ID。在使用服务主体进行身份验证时使用。 |
|
在x509_certificate_path中指定的私钥的指纹。 在使用服务主体进行身份验证时使用。 如果定义了x509_certificate_path，则需要此参数。 |
|
用于创建 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 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
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源是否已更改。 返回值：始终 |
|
负载均衡器的当前状态。 返回值：始终 |