azure_rm_virtualmachinescaleset – Управление группами виртуальных машин Azure

Новая версия 2.4.

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Краткое описание

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

Псевдонимы: azure_rm_virtualmachine_scaleset

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
ad_user строка			Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным объектом службы.
adfs_authority_url строка добавлено в 2.6			URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и собственных полномочиях ADFS.
admin_password -			Пароль для имени пользователя администратора. Не требуется, если os_type — Linux, и аутентификация по паролю SSH отключена, установив ssh_password_enabled в false.
admin_username -			Имя пользователя администратора, используемое для доступа к хосту после его создания. Требуется при создании виртуальной машины.
api_profile строка добавлено в 2.5		По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags логическое значение		Варианты: no да ←	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
application_gateway - добавлено в 2.8			Имя шлюза приложений.
auth_source строка добавлено в 2.5		Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE, которая по умолчанию устанавливается в `auto` при отсутствии переменной. `auto` будет следовать стандартному приоритету модульных параметров —> переменные среды —> профиль по умолчанию в файле учетных данных `~/.azure/credentials`. При установке в `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `msi`, хост-машина должна быть ресурсом Azure с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка. `msi` было добавлено в Ansible 2.6.
capacity -		По умолчанию: 1	Ёмкость VMSS.
cert_validation_mode строка добавлено в 2.5		Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор Azure клиента. Используется при аутентификации с главным объектом службы.
cloud_environment строка добавлено в 2.4		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (определяется Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
custom_data - добавлено в 2.8			Данные, предоставляемые виртуальной машине и используемые, например, cloud-init. Многие образы в маркетплейсе не совместимы с 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 - добавлено в 2.4			Описание списка дисков данных.
	caching - добавлено в 2.4	Варианты: Только чтение ← ReadWrite	Тип кэширования диска данных.
	disk_size_gb - добавлено в 2.4		Начальный размер диска в ГБ для пустых дисков данных.
	lun - добавлено в 2.4	По умолчанию: 0	Логический номер устройства для диска данных.
	managed_disk_type - добавлено в 2.4	Варианты: Standard_LRS Premium_LRS	Тип управляемого диска данных.
enable_accelerated_networking логическое значение добавлено в 2.7		Варианты: no yes	Указывает, хочет ли пользователь разрешить ускоренное сетевое подключение для виртуальных машин в масштабируемом наборе, который создаётся.
image - / обязательно			Определяет образ, используемый для создания виртуальной машины. Если строка, образ берётся из пользовательского образа по имени. Если словарь с ключами `publisher`, `offer`, `sku`, и `version`, образ берётся из образа Маркетплейса. ПРИМЕЧАНИЕ: установите image.version в `latest` для получения последней версии заданного образа. Если словарь с ключами `name` и `resource_group`, образ берётся из пользовательского образа на основе `name` и `resource_group`. ПРИМЕЧАНИЕ: ключ `resource_group` необязателен, и если он опущен, будут проверяться все образы в подписке по `name`. Поддержка пользовательских образов была добавлена в Ansible 2.5
load_balancer - добавлено в 2.5			Имя балансировщика нагрузки.
location -			Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
managed_disk_type -		Варианты: Standard_LRS Premium_LRS	Тип управляемого диска.
name - / обязательно			Имя виртуальной машины.
os_disk_caching -		Варианты: Только чтение ← ReadWrite	Тип кэширования диска ОС. алиасы: disk_caching
os_type -		Варианты: Windows Linux ←	Базовый тип операционной системы.

перераспределение ресурсов boolean добавлено в 2.8	Варианты: нет да ←	Указывает, следует ли перераспределить ресурсы набора виртуальных машин.
пароль -		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
профиль строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
удалить_при_отсутствии -	Значение по умолчанию: ["все"]	При удалении ВМ с состоянием 'отсутствует', также удалить связанные ресурсы. Может быть 'все' или список, содержащий следующие значения: ['сетевые_интерфейсы', 'виртуальные_хранилища', 'общедоступные_IP-адреса']. Любые другие значения будут проигнорированы.
группа_ресурсов - / обязательно		Имя группы ресурсов, содержащей набор виртуальных машин.
секрет строка		Секрет Azure клиента. Используется при аутентификации с сервисным принципалом.
группа_безопасности - добавлено в 2.7		Существующая группа безопасности, с которой следует связать подсеть. Может быть именем группы безопасности в той же группе ресурсов. Может быть идентификатором ресурса. Может быть словарем, содержащим `name` и `resource_group` группы безопасности. псевдонимы: имя_группы_безопасности
короткое_имя_хоста -		Короткое имя хоста
разрешена_парольная_аутентификация_SSH boolean	Варианты: нет да ←	Если тип_ОС Linux, установка разрешена_парольной_аутентификации_SSH в значение false отключит парольную аутентификацию SSH и потребует использования ключей SSH.
общедоступные_ключи_SSH -		Для os_type Linux укажите список ключей SSH. Каждый элемент списка должен быть словарем, содержащим два ключа: путь и данные_ключа. Установите путь к стандартному расположению файлов authorized_keys. Например, на Enterprise Linux хосте путь будет /home/<имя_пользователя_админа>/.ssh/authorized_keys. Установите данные_ключа в фактическое значение открытого ключа.
состояние -	Варианты: отсутствует есть ←	Утверждение состояния набора виртуальных машин. Состояние `present` проверит, существует ли машина с запрошенной конфигурацией. Если конфигурация существующей машины не соответствует, машина будет обновлена. состояние. Состояние `absent` удалит набор виртуальных машин.
имя_подсети -		Имя подсети. псевдонимы: подсеть
идентификатор_подписки строка		Ваш идентификатор подписки Azure.
метки словарь		Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные-метки объекта будут обновлены любыми предоставленными значениями. Для удаления меток установите параметр append_tags в значение false.
аренда строка		Идентификатор аренды Azure. Используется при аутентификации с сервисным принципалом.
уровень -	Варианты: Базовый Стандартный	Уровень SKU.
политика_обновления -	Варианты: Ручной Автоматический	Политика обновления.
имя_виртуальной_сети -		Имя виртуальной сети. псевдонимы: виртуальная_сеть
группа_ресурсов_виртуальной_сети - добавлено в 2.5		При создании виртуальной машины, если должна быть использована определенная виртуальная сеть из другой группы ресурсов, используйте этот параметр для указания группы ресурсов для использования.
размер_ВМ -		Допустимое значение размера виртуальной машины Azure. Например, 'Standard_D4'. Список вариантов зависит от подписки и расположения. Проверьте доступные варианты для вашей подписки.
зоны список добавлено в 2.8		Список зон доступности для набора виртуальных машин.

Примечания

Примечание

Этот модуль назывался azure_rm_virtualmachine_scaleset до Ansible 2.8. Использование не изменилось.
Для аутентификации с Azure вы можете передать параметры, задать переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или выполнить вход перед запуском задач или playbook с помощью az login.
Аутентификация также возможна с помощью сервисного принципала или пользователя Active Directory.
Для аутентификации через сервисный принципал передайте идентификатор_подписки, идентификатор_клиента, секрет и аренда или задайте переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и пароль или задайте AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут быть сохранены в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: идентификатор_подписки, идентификатор_клиента, секрет и аренда или идентификатор_подписки, ad_user и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или задав 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
    subnet_name: testsubnet
    admin_username: adminUser
    ssh_password_enabled: false
    ssh_public_keys:
      - path: /home/adminUser/.ssh/authorized_keys
        key_data: < insert yor ssh public key here... >
    managed_disk_type: Standard_LRS
    image:
      offer: CoreOS
      publisher: CoreOS
      sku: Stable
      version: latest
    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
    subnet_name: testsubnet
    admin_username: adminUser
    admin_password: password01
    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
    subnet_name: testsubnet
    admin_username: adminUser
    admin_password: password01
    managed_disk_type: Standard_LRS
    image:
      name: customimage001
      resource_group: myResourceGroup

Возвращаемые значения

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

Ключ		Возвращаемое	Описание
azure_vmss сложный		всегда	Факты о текущем состоянии объекта. Обратите внимание, что факты не являются частью зарегистрированного вывода, но доступны непосредственно.
	свойства -
	sku -
	метки -
	тип -

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Sertac Ozercan (@sozercan)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_virtualmachinescaleset_module.html