azure_rm_virtualmachine_extension - Управляемое расширение виртуальной машины Azure

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

Обзор
Требования (к хосту, на котором выполняется модуль)
Параметры
Примеры
Значения возврата
Примечания
- Статус

Обзор

Создание, обновление и удаление расширения виртуальной машины Azure

Требования (к хосту, на котором выполняется модуль)

python >= 2.7
azure >= 2.0.0

Параметры

параметр	обязательно	по умолчанию	варианты	комментарии
ad_user	нет			Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным сервисом.
auto_upgrade_minor_version	нет			Автоматически ли модуль обработки расширений должен обновляться между младшими версиями.
client_id	нет			Идентификатор клиента Azure. Используйте при аутентификации с главным сервисом.
cloud_environment	нет	AzureCloud		Для облачных сред, отличных от общедоступного облака США, имя среды (определенное Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
location	нет	location группы ресурсов		Допустимая локация Azure. По умолчанию используется локация группы ресурсов.
name	да			Имя расширения ВМ.
password	нет			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным сервисом.
profile	нет			Профиль безопасности, найденный в файле ~/.azure/credentials.
protected_settings	нет			Защищенные параметры в формате JSON для расширения.
publisher	нет			Имя издателя обработчика расширений.
resource_group	да			Имя группы ресурсов, где существует или будет создано расширение ВМ.
secret	нет			Секрет клиента Azure. Используйте при аутентификации с главным сервисом.
settings	нет			Открытые параметры в формате JSON для расширения.
state	нет	present	absent present	Утвердить состояние расширения ВМ. Используйте 'present' для создания или обновления расширения ВМ и 'absent' для удаления расширения ВМ.
subscription_id	нет			Ваш идентификатор подписки Azure.
tenant	нет			Идентификатор клиента Azure. Используйте при аутентификации с главным сервисом.
type_handler_version	нет			Версия типа обработчика расширения.
virtual_machine_extension_type	нет			Тип обработчика расширения.
virtual_machine_name	нет			Имя виртуальной машины, где должно быть создано или обновлено расширение.

Примеры

- name: Create VM Extension
  azure_rm_virtualmachine_extension:
    name: myvmextension
    location: eastus
    resource_group: Testing
    virtual_machine_name: myvm
    publisher: Microsoft.Azure.Extensions
    virtual_machine_extension_type: CustomScript
    type_handler_version: 2.0
    settings: '{"commandToExecute": "hostname"}'
    auto_upgrade_minor_version: true

- name: Delete VM Extension
  azure_rm_virtualmachine_extension:
    name: myvmextension
    location: eastus
    resource_group: Testing
    virtual_machine_name: myvm
    state: absent

Значения возврата

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

имя	описание	возвращаемое	тип	пример
changed	Изменилось ли ресурс	всегда	bool
state	Текущее состояние расширения ВМ	всегда	dict

Примечания

Примечание

Для аутентификации в Azure можно передавать параметры, устанавливать переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью главного сервиса или пользователя 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. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

Статус

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

Для помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочитайте Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.

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