azure_rm_virtualmachine_extension - Управляемый модуль расширений виртуальных машин Azure
Новая версия 2.4.
Обзор
- Создание, обновление и удаление расширения виртуальной машины Azure
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| adfs_authority_url (добавлен в 2.6) | По умолчанию: null | URL авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. |
| api_profile (добавлен в 2.5) | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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. |
| auto_upgrade_minor_version bool |
| Автоматически ли расширение обработчика должно обновляться между версиями. |
| cert_validation_mode (добавлен в 2.5) |
| Управляет поведением проверки сертификатов для 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. |
| location | Действительное расположение Azure. По умолчанию соответствует расположению группы ресурсов. | |
| name обязательно | Имя расширения ВМ. | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| profile | Профиль безопасности в файле ~/.azure/credentials. | |
| protected_settings | Защищенные настройки в формате JSON для расширения. | |
| publisher | Имя издателя обработчика расширений. | |
| resource_group обязательно | Имя группы ресурсов, где расширение виртуальной машины существует или будет создано. | |
| secret | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| settings | Настройки в формате JSON для расширения. | |
| state |
| Утверждение состояния расширения виртуальной машины. Используйте 'present' для создания или обновления расширения виртуальной машины и 'absent' для удаления расширения виртуальной машины. |
| subscription_id | Ваш идентификатор подписки Azure. | |
| tenant | Идентификатор клиента 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 | всегда | Текущее состояние расширения ВМ |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Для получения дополнительной информации см. Техническое обслуживание модулей и поддержка.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_virtualmachine_extension_module.html
