azure.azcollection.azure_rm_virtualmachinescaleset 模块 – 管理 Azure 虚拟机规模集
注意
此模块是 azure.azcollection 集合 (版本 3.1.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。
要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_virtualmachinescaleset。
azure.azcollection 0.1.2 中的新增功能
概要
创建和更新虚拟机规模集。
请注意，在 Ansible 2.8 之前，此模块称为 azure.azcollection.azure_rm_virtualmachine_scaleset。用法没有改变。
要求
以下要求是在执行此模块的主机上需要的。
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 权威机构时使用。 |
|
管理员用户名密码。 如果 os_type 为 Linux 并且通过设置 *ssh_password_enabled=false* 禁用了 SSH 密码身份验证，则不需要。 |
|
用于在创建主机后访问主机的管理员用户名。创建虚拟机时需要。 |
|
选择在与 Azure 服务通信时使用的 API 配置文件。 默认值： |
|
用于控制标签字段是规范的还是只是附加到现有标签。 当规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项
|
|
应用程序网关名称。 |
|
控制用于身份验证的凭据来源。 也可以通过 当设置为 当设置为 当设置为 当设置为 当设置为 Ansible 2.6 中添加了 选项
|
|
VMSS 的容量。 默认值： |
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都会验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选项
|
|
Azure 客户端 ID。使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 |
|
对于除美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 默认值： |
|
提供给虚拟机并由例如 市场中的许多映像并非 cloud-init 就绪。因此，发送到 custom_data 的数据将被忽略。 如果您尝试使用的映像未列在 https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init#cloud-init-overview 中，请按照以下步骤操作 https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cloudinit-prepare-custom-image。 |
|
描述数据磁盘列表。 |
|
数据磁盘缓存类型。 选项
|
|
空白数据磁盘的初始磁盘大小（以 GB 为单位）。 |
|
数据磁盘的逻辑单元号。 默认值： |
|
托管数据磁盘类型。 选项
|
|
确定尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 检索权限元数据以验证权限。通过将其设置为 **True**，将禁用权限的验证。因此，务必确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或 选项
|
|
指示用户是否希望允许为正在创建的规模集中的虚拟机启用加速网络。 选项
|
|
可以为操作系统磁盘指定的短暂磁盘设置参数。 短暂操作系统磁盘仅支持使用托管磁盘的 VMS 实例。 选项
|
|
指定 Azure Spot 虚拟机的逐出策略。 需要将优先级设置为 Spot。 选项
|
|
对象的标识 |
|
托管标识的类型 选项
|
|
用户分配的托管标识及其选项 默认值： |
|
如果需要将标识列表附加到当前标识 (true)，或者是否需要替换当前标识 (false) 选项
|
|
与对象关联的用户分配的标识 ID 列表 默认值： |
|
指定用于构建 VM 的映像。 如果为字符串，则映像源自基于名称的自定义映像。 如果为包含键 publisher、offer、sku 和 version 的字典，则映像源自 Marketplace 映像。请注意，设置 version=latest 以获取给定映像的最新版本。 如果为包含键 name 和 resource_group 的字典，则映像源自基于设置的 name 和 resource_group 的自定义映像。请注意，键 resource_group 是可选的，如果省略，则将按 name 搜索订阅中的所有映像。 Ansible 2.5 中添加了自定义映像支持。 对于社区映像，包含键 community_gallery_image_id 的字典。指定用于 VM 部署的社区库映像唯一 ID。 可以从共享库映像 GET 调用中获取 community_gallery_image_id。 创建时必需。 |
|
负载均衡器名称。 |
|
有效的 Azure 位置。默认为资源组的位置。 |
|
父参数。 |
|
父参数。 |
|
托管磁盘类型。 选项
|
|
指定您愿意为 Azure Spot VM/VMSS 支付的最高价格。 此价格以美元计。
需要将优先级设置为 Spot。 默认值： |
|
虚拟机的名称。 |
|
指定虚拟机规模集的编排模式。 当 orchestration_mode=Flexible 时，必须设置 public_ip_per_vm=True。 当 orchestration_mode=Flexible 时，必须设置 platform_fault_domain_count。 当 orchestration_mode=Flexible 时，必须设置 single_placement_group=False。 当 orchestration_mode=Flexible 时，无法配置 overprovision。 当 orchestration_mode=Flexible 时，无法配置 upgrade_policy，而当 orchestration_mode=Uniform 时可以配置。 选项
|
|
操作系统磁盘缓存类型。 选项
|
|
指定操作系统磁盘的大小（以 GB 为单位）。 这可以用来覆盖虚拟机映像中磁盘的大小。 |
|
操作系统的基本类型。 选项
|
|
指定是否应过度配置虚拟机规模集。 选项
|
|
Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
VM 的第三方计费计划。 |
|
计费计划名称。 |
|
产品名称。 |
|
可选促销代码。 |
|
提供计划的发布者。 |
|
每个放置组的故障域计数。 默认值： |
|
VMSS 的优先级。
选项
|
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
为规模集的每个虚拟机分配一个公共 IP 选项
|
|
使用 state=absent 删除 VM 时，还删除关联的资源。 可以是 任何其他输入都将被忽略。 默认值： |
|
包含虚拟机规模集的资源组的名称。 |
|
定义缩减 VMSS 实例的顺序 选项
|
|
Azure 客户端密钥。使用服务主体进行身份验证时使用。 |
|
与子网关联的现有安全组。 它可以是位于同一资源组中的安全组名称。 它可以是资源 ID。 它可以是包含安全组的 name 和 resource_group 的字典。 |
|
指定虚拟机规模集的安全相关配置文件设置。 |
|
用户可以在请求中使用此属性来启用或禁用虚拟机规模集的主机加密。 这将启用所有磁盘的加密，包括主机本身的资源/临时磁盘。 选项
|
|
指定虚拟机规模集的SecurityType。 将其设置为TrustedLaunch以启用UefiSettings。 选项
|
|
指定创建虚拟机规模集时使用的安全设置，例如安全启动和vTPM。 |
|
指定是否应在虚拟机规模集上启用安全启动。 选项
|
|
指定是否应在虚拟机规模集上启用vTPM。 选项
|
|
简短主机名。 |
|
如果为true，则将规模集限制为单个放置组，最大规模为100台虚拟机。 选项
|
|
当os_type为Linux时，设置ssh_password_enabled=false将禁用SSH密码身份验证，并要求使用SSH密钥。 选项
|
|
对于os_type=Linux，提供SSH密钥列表。 列表中的每个项目都应该是一个字典，该字典包含两个键， 将 例如，在企业Linux主机上，path=/home/<admin username>/.ssh/authorized_keys。将 |
|
断言虚拟机规模集的状态。 状态 状态 选项
|
|
子网名称。 |
|
您的Azure订阅ID。 |
|
字符串：字符串对的字典，作为元数据分配给对象。 对象的元数据标签将使用任何提供的数值进行更新。 要删除标签，请将append_tags选项设置为false。 目前，Azure DNS区域和流量管理器服务也不允许在标签中使用空格。 Azure前端门不支持使用 Azure自动化和Azure CDN每个资源仅支持15个标签。 |
|
Azure租户ID。使用服务主体进行身份验证时使用。 |
|
终止通知事件的超时时间 范围在5到15之间 |
|
x509_certificate_path中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了x509_certificate_path，则需要此参数。 |
|
SKU层级。 选项
|
|
升级策略。 创建Azure虚拟机规模集时需要。 选项
|
|
虚拟网络名称。 |
|
创建虚拟机时，如果应使用来自另一个资源组的特定虚拟网络。 使用此参数指定要使用的资源组。 |
|
有效的Azure VM大小值。例如， 选项列表因订阅和位置而异。检查您的订阅以获取可用选项。 |
|
用于创建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 VMSS
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 2
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
terminate_event_timeout_minutes: 10
scale_in_policy: NewestVM
admin_username: "{{ username }}"
ssh_password_enabled: false
ssh_public_keys:
- path: /home/adminUser/.ssh/authorized_keys
key_data: < insert your ssh public key here... >
managed_disk_type: Standard_LRS
image:
offer: 0001-com-ubuntu-server-focal
publisher: canonical
sku: 20_04-lts-gen2
version: latest
data_disks:
- lun: 0
disk_size_gb: 64
caching: ReadWrite
managed_disk_type: Standard_LRS
- name: Create VMSS with an image that requires plan information
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 3
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: "{{ username }}"
ssh_password_enabled: false
ssh_public_keys:
- path: /home/adminUser/.ssh/authorized_keys
key_data: < insert your ssh public key here... >
managed_disk_type: Standard_LRS
image:
offer: cis-ubuntu-linux-1804-l1
publisher: center-for-internet-security-inc
sku: Stable
version: latest
plan:
name: cis-ubuntu-linux-1804-l1
product: cis-ubuntu-linux-1804-l1
publisher: center-for-internet-security-inc
data_disks:
- lun: 0
disk_size_gb: 64
caching: ReadWrite
managed_disk_type: Standard_LRS
- name: Create a VMSS with a custom image
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 2
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: "{{ username }}"
admin_password: "{{ password }}"
managed_disk_type: Standard_LRS
image: customimage001
- name: Create a VMSS with a community gallery image ID
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_D8_v4
admin_username: testuser
single_placement_group: false
platform_fault_domain_count: 1
public_ip_per_vm: true
ssh_password_enabled: false
ssh_public_keys:
- path: /home/testuser/.ssh/authorized_keys
key_data: "ssh-rsa ********* [email protected]"
virtual_network_name: VMSStestVnet
subnet_name: VMSStestSubnet
managed_disk_type: Standard_LRS
orchestration_mode: Flexible
os_disk_caching: ReadWrite
image:
community_gallery_image_id: "/CommunityGalleries/yellowbrick-fc7e81f1-87dd-4989-9ca8-03743762e873/Images/Ubuntu-5.15.0-1035-azure_22.04"
data_disks:
- lun: 0
disk_size_gb: 64
caching: ReadWrite
managed_disk_type: Standard_LRS
- name: Create a VMSS with over 100 instances
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 120
single_placement_group: false
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: "{{ username }}"
admin_password: "{{ password }}"
managed_disk_type: Standard_LRS
image: customimage001
- name: Create a VMSS with a custom image from a particular resource group
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 2
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: "{{ username }}"
admin_password: "{{ password }}"
managed_disk_type: Standard_LRS
image:
name: customimage001
resource_group: myResourceGroup
- name: Create a VMSS with Spot Instance
azure_rm_virtualmachinescaleset:
resource_group: myResourceGroup
name: testvmss
vm_size: Standard_DS1_v2
capacity: 5
priority: Spot
eviction_policy: Deallocate
virtual_network_name: testvnet
upgrade_policy: Manual
subnet_name: testsubnet
admin_username: "{{ username }}"
admin_password: "{{ password }}"
managed_disk_type: Standard_LRS
image: customimage001
- name: Create VMSS with security group
azure_rm_virtualmachinescaleset:
resource_group: "{{ resource_group }}"
name: testVMSS{{ rpfx }}
vm_size: Standard_D4s_v3
admin_username: testuser
single_placement_group: false
platform_fault_domain_count: 1
public_ip_per_vm: true
ssh_password_enabled: false
ssh_public_keys:
- path: /home/testuser/.ssh/authorized_keys
key_data: "ssh-rsa ****"
virtual_network_name: VMSStestVnet
subnet_name: VMSStestSubnet
managed_disk_type: Standard_LRS
orchestration_mode: Flexible
os_disk_caching: ReadWrite
security_profile:
uefi_settings:
secure_boot_enabled: true
v_tpm_enabled: false
encryption_at_host: false
security_type: TrustedLaunch
image:
offer: 0001-com-ubuntu-server-jammy
publisher: Canonical
sku: 22_04-lts-gen2
version: latest
data_disks:
- lun: 0
disk_size_gb: 64
caching: ReadWrite
managed_disk_type: Standard_LRS
返回值
常用返回值已记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
有关对象当前状态的事实。 请注意，事实不是注册输出的一部分，而是直接可用。 返回：始终 示例： |