azure.azcollection.azure_rm_autoscale 模块 – 管理 Azure 自动缩放设置
注意
此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。
要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_autoscale。
azure.azcollection 0.1.2 中的新增功能
概要
创建、删除自动缩放设置。
要求
在执行此模块的主机上需要以下要求。
python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合 requirements.txt 中列出的所有 python 包
完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到
参数
参数 |
注释 |
|---|---|
Active Directory 用户名。在通过 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
Azure AD 授权 URL。在通过用户名/密码进行身份验证，并且拥有自己的 ADFS 授权时使用。 |
|
选择与 Azure 服务通信时要使用的 API 配置文件。默认值 默认值： |
|
用于控制 tags 字段是规范的还是仅附加到现有标记。 当为规范时，在 tags 参数中找不到的任何标记都将从对象的元数据中删除。 选择
|
|
控制用于身份验证的凭据来源。 也可以通过 当设置为 当设置为 当设置为 当设置为 当设置为
选择
|
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都会验证服务器证书，但是当使用 HTTPS 代理时，或者针对 Azure Stack 时，可能需要通过传递 选择
|
|
Azure 客户端 ID。在使用服务主体或托管身份 (msi) 进行身份验证时使用。 也可以通过 |
|
对于美国公共云之外的云环境，可以使用环境名称（由 Azure Python SDK 定义，例如， 默认值: |
|
确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此项设置为 **True**，将禁用授权验证。因此，必须确保配置的授权主机有效且可信。 通过凭据文件配置文件或 选择
|
|
指定是否为资源启用了自动缩放。 选择
|
|
资源的位置。 |
|
父参数。 |
|
父参数。 |
|
资源的名称。 |
|
通知的集合。 |
|
自定义电子邮件列表。此值可以为 null 或空，在这种情况下将忽略此属性。 |
|
一个值，指示是否向订阅管理员发送电子邮件。 选择
|
|
一个值，指示是否向订阅共同管理员发送电子邮件。 选择
|
|
Webhook 通知服务 URI 的列表。 |
|
Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
自动缩放配置文件的集合，这些配置文件指定不同时间段的不同缩放参数。 最多可以指定 20 个配置文件。 |
|
如果指标不可用于评估，将设置的实例数。 仅当当前实例计数低于默认值时才使用默认值。 |
|
配置文件的特定日期时间结束时间。 如果使用 Recurrence 元素，则不使用此元素。 |
|
配置文件的特定日期时间开始时间。 如果使用 Recurrence 元素，则不使用此元素。 |
|
配置文件的特定日期时间时区。 如果使用 Recurrence 元素，则不使用此元素。 |
|
资源的最大实例数。 实际最大实例数受订阅中可用的核心数限制。 |
|
资源的最小实例数。 |
|
配置文件的名称。 |
|
此配置文件开始重复的时间的日期。 如果使用 FixedDate 元素，则不使用此元素。 |
|
计划配置文件生效的频率。 如果此值为 如果使用 FixedDate 元素，则不使用此元素。 选择
|
|
此配置文件开始重复的时间的小时数。 如果使用 FixedDate 元素，则不使用此元素。 |
|
此配置文件开始重复的时间的分钟数。 如果使用 FixedDate 元素，则不使用此元素。 |
|
此配置文件开始重复的时间的时区。 如果使用 FixedDate 元素，则不使用此元素。 |
|
提供缩放操作触发器和参数的规则集合。 最多可以指定 10 个规则。 |
|
自上次缩放操作发生后，此操作发生之前要等待的时间（分钟）。 它必须介于 1 到 10080 之间。 |
|
维度条件列表。 |
|
维度的名称。 |
|
维度运算符。仅支持 选择
|
|
维度值列表。 |
|
缩放操作是增加还是减少实例数。 选择
|
|
一个值，指示是否应按实例划分指标。 选择
|
|
定义规则监视内容的指标的名称。 |
|
定义规则监视内容的指标的命名空间。 |
|
规则监视的资源的资源标识符。 |
|
用于比较指标数据和阈值的运算符。 选择
|
|
如何组合来自多个实例的指标。 选择
|
|
触发缩放操作的指标阈值。 默认值: |
|
如何随着时间的推移组合收集的数据。 选择
|
|
规则监视的指标的粒度（分钟）。 必须是指标的指标定义返回的预定义值之一。 必须介于 1 到 720 之间。 |
|
收集实例数据的时间范围（分钟）。 此值必须大于指标收集中的延迟，指标收集中的延迟可能因资源而异。 必须介于 5 到 720 之间。 |
|
缩放规则触发时应发生的操作类型。 选择
|
|
缩放操作中涉及的实例数。 此值必须为 1 或更大。 |
|
资源的资源组。 |
|
Azure 客户端密钥。在使用服务主体进行身份验证时使用。 |
|
断言虚拟网络的状态。使用 选择
|
|
你的 Azure 订阅 ID。 |
|
要作为元数据分配给对象的 string:string 对的字典。 对象上的元数据标记将使用任何提供的值进行更新。 要删除标记，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。 Azure 前门不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标记。 |
|
要应用自动缩放设置的资源的标识符。 它可以是资源 ID 字符串。 它也可以是一个字典，包含资源的 |
|
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 和密码，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。
或者，凭据可以存储在 ~/.azure/credentials 中。这是一个 ini 文件，其中包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant，或 subscription_id、ad_user 和密码。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。
另请参阅
另请参阅
- 使用 Azure CLI 登录
如何使用
az login命令进行身份验证。
示例
- name: Create an auto scale
azure_rm_autoscale:
target: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVmss"
enabled: true
profiles:
- count: '1'
recurrence_days:
- Monday
name: Auto created scale condition
recurrence_timezone: China Standard Time
recurrence_mins:
- '0'
min_count: '1'
max_count: '1'
recurrence_frequency: Week
recurrence_hours:
- '18'
name: scale
resource_group: myResourceGroup
- name: Create an auto scale with complicated profile
azure_rm_autoscale:
target: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets
/myVmss"
enabled: true
profiles:
- count: '1'
recurrence_days:
- Monday
name: Auto created scale condition 0
rules:
- time_aggregation: Average
time_window: 10
direction: Increase
metric_name: Percentage CPU
metric_resource_uri: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtua
lMachineScaleSets/vmss"
value: '1'
threshold: 70
cooldown: 5
time_grain: 1
statistic: Average
operator: GreaterThan
type: ChangeCount
dimensions:
- dimension_name: AppName
operator: Equals
values:
- App1
- App2
max_count: '1'
recurrence_mins:
- '0'
min_count: '1'
recurrence_timezone: China Standard Time
recurrence_frequency: Week
recurrence_hours:
- '6'
notifications:
- email_admin: true
email_co_admin: false
custom_emails:
- [email protected]
name: scale
resource_group: myResourceGroup
- name: Delete an Azure Auto Scale Setting
azure_rm_autoscale:
state: absent
resource_group: myResourceGroup
name: scale
返回值
常见的返回值记录在这里，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源的当前状态。 返回: 始终 示例: |