Модуль azure.azcollection.azure_rm_virtualmachinescaleset — управление масштабируемыми наборами виртуальных машин Azure

ad_user

string

Имя пользователя Active Directory. Используйте этот параметр для аутентификации с помощью пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используйте этот параметр для аутентификации по имени пользователя и паролю при наличии собственного центра ADFS.

admin_password

string

Пароль для имени пользователя администратора.

Не требуется, если значение os_type — Linux, а аутентификация SSH по паролю отключена с помощью параметра ssh_password_enabled=false.

admin_username

string

Имя пользователя администратора, используемое для доступа к узлу после его создания. Обязательно при создании виртуальной машины.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

Определяет, является ли поле тегов каноническим или теги только добавляются к существующим.

Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

• false
• true ← (по умолчанию)

application_gateway

string

Имя шлюза приложений.

application_security_groups

list / elements=string

Задает массив ссылок на группы безопасности приложений. Идентификатор ресурса группы безопасности приложений.

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; в противном случае будет использоваться подписка az cli по умолчанию.

Если задано значение msi, узел должен быть ресурсом Azure с включенным расширением MSI. Для указания идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

capacity

integer

Емкость VMSS.

По умолчанию: 1

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет поведение проверки сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Это также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

client_id

string

Идентификатор клиента Azure. Используйте этот параметр для аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (определенное в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Это также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

custom_data

string

Данные, предоставляемые виртуальной машине и используемые, например, cloud-init.

Многие образы из Marketplace не поддерживают 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.

data_disks

list / elements=dictionary

Описывает список дисков данных.

caching

string

Тип кэширования диска данных.

Варианты:

• "ReadOnly" ← (по умолчанию)
• "ReadWrite"

disk_encryption_set

string

Идентификатор ресурса набора шифрования дисков для дисков данных.

disk_size_gb

integer

Начальный размер пустых дисков данных в ГБ.

lun

string

Номер логического устройства диска данных.

По умолчанию: "0"

managed_disk_type

string

Тип управляемого диска данных.

Варианты:

• "Standard_LRS"
• "Premium_LRS"
• "StandardSSD_LRS"
• "UltraSSD_LRS"
• "Premium_ZRS"
• "StandardSSD_ZRS"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых недоступна конечная точка метаданных, например в частных облаках или Azure Stack. При обнаружении экземпляра из https://login.microsoft.com/ извлекаются метаданные центра для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

enable_accelerated_networking

boolean

Указывает, разрешает ли пользователь ускорение сети для создаваемых виртуальных машин в масштабируемом наборе.

Варианты:

• false
• true

ephemeral_os_disk

boolean

Параметры временного диска, которые можно указать для диска операционной системы.

Временный диск ОС поддерживается только для экземпляров VMS, использующих управляемый диск.

Варианты:

• false
• true

eviction_policy

string

Указывает политику вытеснения для виртуальной машины Azure Spot.

Для параметра priority необходимо задать значение Spot.

Варианты:

• "Deallocate"
• "Delete"

identity

dictionary

Удостоверение объекта

type

string

Тип управляемого удостоверения

Варианты:

• "SystemAssigned"
• "UserAssigned"
• "SystemAssigned, UserAssigned"
• "None" ← (по умолчанию)

user_assigned_identities

dictionary

Назначенные пользователем управляемые удостоверения и их параметры

По умолчанию: {}

append

boolean

Следует ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false).

Варианты:

• false
• true ← (по умолчанию)

id

list / elements=string

Список идентификаторов назначенных пользователем удостоверений, связанных с объектом

По умолчанию: []

image

any

Указывает образ, используемый для создания виртуальной машины.

Если указана строка, образ выбирается по имени из пользовательских образов.

Если указан словарь с ключами publisher, offer, sku и version, образ выбирается из Marketplace. Чтобы получить последнюю версию указанного образа, задайте version=latest.

Если указан словарь с ключами name и resource_group, образ выбирается из пользовательских образов по указанным значениям name и resource_group. Ключ resource_group является необязательным. Если он не указан, поиск образа по name выполняется во всех группах подписки.

Поддержка пользовательских образов добавлена в Ansible 2.5.

Для образов сообщества укажите словарь с ключом community_gallery_image_id. Задайте уникальный идентификатор образа из галереи сообщества для развертывания виртуальной машины.

Значение community_gallery_image_id можно получить с помощью запроса GET к образу общей галереи.

Обязательно при создании.

load_balancer

string

Имя балансировщика нагрузки.

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

managed_disk_type

string

Тип управляемого диска.

Варианты:

• "Standard_LRS"
• "Premium_LRS"
• "StandardSSD_LRS"
• "UltraSSD_LRS"
• "Premium_ZRS"
• "StandardSSD_ZRS"

max_price

float

Указывает максимальную цену, которую вы готовы заплатить за виртуальную машину или масштабируемый набор Azure Spot.

Цена указывается в долларах США.

-1 указывает цену по умолчанию, не превышающую цену по запросу.

Для параметра priority необходимо задать значение Spot.

По умолчанию: -1.0

name

string / обязательный

Имя виртуальной машины.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

orchestration_mode

string

Указывает режим оркестрации масштабируемого набора виртуальных машин.

Если задано 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.

Варианты:

• "Flexible" ← (по умолчанию)
• "Uniform"

os_disk_caching

псевдонимы: disk_caching

string

Тип кэширования диска ОС.

Варианты:

• "ReadOnly" ← (по умолчанию)
• "ReadWrite"

os_disk_encryption_set

string

Идентификатор ресурса набора шифрования дисков для диска ОС.

os_disk_size_gb

integer

Указывает размер диска операционной системы в гигабайтах.

Этот параметр можно использовать, чтобы переопределить размер диска в образе виртуальной машины.

os_type

string

Базовый тип операционной системы.

Варианты:

• "Windows"
• "Linux" ← (по умолчанию)
• "windows"
• "linux"

overprovision

boolean

Указывает, следует ли использовать избыточное выделение ресурсов для набора масштабирования виртуальных машин.

Варианты:

• false
• true

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта-службы.

plan

dictionary

План выставления счетов стороннего поставщика для виртуальной машины.

name

string / обязательный

Название плана выставления счетов.

product

string / обязательный

Название продукта.

promotion_code

string

Необязательный промокод.

publisher

string / обязательный

Издатель, предлагающий план.

platform_fault_domain_count

integer

Количество доменов сбоя для каждой группы размещения.

По умолчанию: 1

priority

string

Приоритет VMSS.

None эквивалентен обычной виртуальной машине.

Варианты:

• "None"
• "Spot"
• "Regular"

private_ip_address_version

string

Доступно начиная с версии API 2017-03-30; определяет, является ли конкретная ipconfiguration IPv4 или IPv6.

По умолчанию используется IPv4.

Варианты:

• "IPv4"
• "IPv6"

profile

string

Профиль безопасности из файла ~/.azure/credentials.

public_ip_per_vm

boolean

Назначить общедоступный IP-адрес каждой виртуальной машине набора масштабирования

Варианты:

• false ← (по умолчанию)
• true

remove_on_absent

list / elements=string

При удалении виртуальной машины с помощью state=absent также удалять связанные ресурсы.

Значением может быть all или список, содержащий любые из следующих значений: [‘network_interfaces’, ‘virtual_storage’, ‘public_ips’].

Любые другие значения будут проигнорированы.

По умолчанию: ["all"]

resource_group

string / обязательный

Имя группы ресурсов, содержащей набор масштабирования виртуальных машин.

scale_in_policy

string

Определяет порядок уменьшения масштаба экземпляров VMSS.

Варианты:

• "Default"
• "NewestVM"
• "OldestVM"

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

security_group

псевдонимы: security_group_name

any

Существующая группа безопасности, с которой следует связать подсеть.

Это может быть имя группы безопасности в той же группе ресурсов.

Это может быть идентификатор ресурса.

Это может быть словарь, содержащий name и resource_group группы безопасности.

security_profile

dictionary

Задает параметры профиля безопасности для набора масштабирования виртуальных машин.

encryption_at_host

boolean

Это свойство можно использовать в запросе, чтобы включить или отключить шифрование узла для набора масштабирования виртуальных машин.

Это включит шифрование всех дисков, включая диски ресурсов и временные диски непосредственно на узле.

Варианты:

• false
• true

security_type

string

Задает тип безопасности набора масштабирования виртуальных машин.

Для включения UefiSettings устанавливается значение TrustedLaunch.

Варианты:

• "TrustedLaunch"

uefi_settings

dictionary

Задает параметры безопасности, такие как безопасная загрузка и vTPM, используемые при создании набора масштабирования виртуальных машин.

secure_boot_enabled

boolean

Указывает, следует ли включить безопасную загрузку для набора масштабирования виртуальных машин.

Варианты:

• false
• true

v_tpm_enabled

boolean

Указывает, следует ли включить vTPM для набора масштабирования виртуальных машин.

Варианты:

• false
• true

short_hostname

string

Короткое имя узла.

single_placement_group

boolean

Если значение равно true, набор масштабирования ограничивается одной группой размещения максимального размера 100 виртуальных машин.

Варианты:

• false ← (по умолчанию)
• true

ssh_password_enabled

boolean

Если для os_type задано значение Linux, установка ssh_password_enabled=false отключит аутентификацию SSH по паролю и потребует использования ключей SSH.

Варианты:

• false
• true ← (по умолчанию)

ssh_public_keys

list / elements=dictionary

Для os_type=Linux укажите список ключей SSH.

Каждый элемент списка должен быть словарем с двумя ключами: path и key_data.

Задайте для path расположение файлов authorized_keys по умолчанию.

Например, на узле Enterprise Linux укажите path=/home/<admin username>/.ssh/authorized_keys. Для key_data задайте фактическое значение открытого ключа.

state

string

Задает требуемое состояние набора масштабирования виртуальных машин.

Состояние present проверяет, существует ли виртуальная машина с требуемой конфигурацией. Если конфигурация существующей виртуальной машины не совпадает, она будет обновлена.

Состояние absent удаляет набор масштабирования виртуальных машин.

Варианты:

• "absent"
• "present" ← (по умолчанию)

subnet_name

псевдонимы: subnet

string

Имя подсети.

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар строка:строка, назначаемых объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с использованием всех переданных значений.

Чтобы удалить теги, установите для параметра append_tags значение false.

В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

terminate_event_timeout_minutes

integer

Время ожидания события уведомления о завершении

в диапазоне от 5 до 15

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

tier

string

Уровень SKU.

Варианты:

• "Basic"
• "Standard"

upgrade_policy

string

Политика обновления.

Обязательна при создании наборов масштабирования виртуальных машин Azure.

Варианты:

• "Manual"
• "Automatic"

virtual_network_name

псевдонимы: virtual_network

string

Имя виртуальной сети.

virtual_network_resource_group

string

При создании виртуальной машины этот параметр используется, если требуется виртуальная сеть из другой группы ресурсов.

Укажите с его помощью группу ресурсов.

vm_size

string

Допустимое значение размера виртуальной машины Azure. Например, Standard_D4.

Список доступных вариантов зависит от подписки и расположения. Проверьте доступные варианты для своей подписки.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат необходимо добавить к закрытому ключу.

Используйте при аутентификации с помощью субъекта-службы.

zones

list / elements=string

Список зон доступности для набора масштабирования виртуальных машин.

azure_vmss

dictionary

Сведения о текущем состоянии объекта.

Обратите внимание, что эти сведения не входят в зарегистрированный вывод, но доступны напрямую.

Возвращается: всегда

Пример: {"constrained_maximum_capacity": false, "etag": "3", "id": "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG02/providers/Microsoft.Compute/virtualMachineScaleSets/testVMSStestvmss", "location": "eastus", "name": "testVMSStestvmss", "orchestration_mode": "Flexible", "platform_fault_domain_count": 1, "provisioning_state": "Succeeded", "single_placement_group": false, "sku": {"capacity": 1, "name": "Standard_A1_v2", "tier": "Standard"}, "tags": {"key2": "value2", "key3": "value3"}, "time_created": "2025-04-22T08:03:29.427822Z", "type": "Microsoft.Compute/virtualMachineScaleSets", "unique_id": "da4393f5-6060-4a0e-8ae5-7616316402b8", "upgrade_policy": {"mode": "Manual"}, "virtual_machine_profile": {"network_profile": {"network_api_version": "2020-11-01", "network_interface_configurations": [{"auxiliary_mode": "None", "auxiliary_sku": "None", "delete_option": "Delete", "disable_tcp_state_tracking": false, "dns_settings": {"dns_servers": []}, "enable_ip_forwarding": false, "ip_configurations": [{"application_gateway_backend_address_pools": [], "application_security_groups": [{"id": "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG02/providers/Microsoft.Network/applicationSecurityGroups/apptestvmss02"}, {"id": "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG02/providers/Microsoft.Network/applicationSecurityGroups/apptestvmss"}], "load_balancer_backend_address_pools": [], "name": "default", "primary": true, "private_ip_address_version": "IPv4", "public_ip_address_configuration": {"idle_timeout_in_minutes": 4, "ip_tags": [], "name": "instancepublicip", "public_ip_address_version": "IPv4"}, "subnet": {"id": "/subscriptions/xxx-xxx/resourceGroups/v-xisuRG02/providers/Microsoft.Network/virtualNetworks/VMSStestVnet/subnets/VMSStestSubnet"}}], "name": "testVMSStestvmss", "primary": true}]}, "os_profile": {"admin_username": "testuser", "allow_extension_operations": true, "computer_name_prefix": "testVMSStestvmss", "linux_configuration": {"disable_password_authentication": true, "patch_settings": {"assessment_mode": "ImageDefault", "patch_mode": "ImageDefault"}, "provision_vm_agent": true, "ssh": {"public_keys": [{"key_data": "ssh-rsa xxxxxxxxxx xx.yy@qq.com", "path": "/home/testuser/.ssh/authorized_keys"}]}}, "require_guest_provision_signal": true, "secrets": []}, "storage_profile": {"data_disks": [{"caching": "ReadWrite", "create_option": "Empty", "delete_option": "Delete", "disk_size_gb": 64, "lun": 0, "managed_disk": {"storage_account_type": "Standard_LRS"}}], "image_reference": {"offer": "0001-com-ubuntu-server-focal", "publisher": "Canonical", "sku": "20_04-lts", "version": "20.04.202504030"}, "os_disk": {"caching": "ReadWrite", "create_option": "FromImage", "delete_option": "Delete", "disk_size_gb": 30, "managed_disk": {"storage_account_type": "Standard_LRS"}, "os_type": "Linux"}}, "time_created": "2025-04-22T08:53:17.201851Z"}}