azure_rm_virtualmachine_extension - Модуль управляемого расширения виртуальной машины Azure
Новое в версии 2.4.
Обзор
- Создание, обновление и удаление расширения виртуальной машины Azure
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала. |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменных среды -> профилю по умолчанию в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| auto_upgrade_minor_version | Следует ли автоматически обновлять обработчик расширения между младшими версиями. | |
| cert_validation_mode (добавлено в 2.5) |
None | Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала. |
| cloud_environment (добавлено в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment ), или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| location | Значение по умолчанию: местоположение группы ресурсов | Допустимое местоположение Azure. По умолчанию совпадает с местоположением группы ресурсов. |
| name обязательно | Имя расширения ВМ | |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| protected_settings | Защищенные параметры в формате JSON для расширения. | |
| publisher | Имя издателя обработчика расширения. | |
| resource_group обязательно | Имя группы ресурсов, в которой существует или будет создано расширение ВМ. | |
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используйте при аутентификации с помощью службы-принципала. |
| settings | Открытые параметры в формате JSON для расширения. | |
| state |
| Утверждение состояния расширения ВМ. Используйте 'present' для создания или обновления расширения ВМ и 'absent' для удаления расширения ВМ. |
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. |
| tenant | Значение по умолчанию: None | Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала. |
| type_handler_version | Версия типа обработчика расширения. | |
| virtual_machine_extension_type | Тип обработчика расширения. | |
| virtual_machine_name | Имя виртуальной машины, где должно быть создано или обновлено расширение. |
Примечания
Примечание
- Для аутентификации с 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 в среде.
Примеры
- 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 | всегда | Текущее состояние расширения ВМ |
Статус
Этот модуль помечен как бета-версия, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- Sertac Ozercan (@sozercan)
- Julien Stroheker (@julienstroheker)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_virtualmachine_extension_module.html
