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

Примечание

Этот плагин является частью коллекции community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Для использования в книге задач укажите: community.azure.azure_rm_virtualmachine_extension.

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

Обзор

Создание, обновление и удаление расширения виртуальной машины Azure.
Обратите внимание, что этот модуль назывался community.azure.azure_rm_virtualmachine_extension до Ansible 2.8. Использование не изменилось.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 0.0.1 azure.azcollection		URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS.
api_profile строка добавлено в 0.0.1 azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
auth_source строка добавлено в 0.0.1 azure.azcollection	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (по умолчанию) приоритет имеет: параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных среды. При значении `credential_file`, профиль будет считываться из `~/.azure/credentials`. При значении `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если их несколько, в противном случае используется подписка по умолчанию Azure CLI. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
auto_upgrade_minor_version булево	Варианты: no yes	Автоматически ли будет обновляться обработчик расширения между версиями?
cert_validation_mode строка добавлено в 0.0.1 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано в профиле файла учетных данных или в переменной среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 azure.azcollection	По умолчанию: "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 строка	Варианты: absent present ←	Состояние расширения ВМ. Используйте `present` для создания или обновления расширения ВМ, и `absent` для удаления расширения ВМ.
subscription_id строка		Идентификатор вашей подписки Azure.
tenant строка		Идентификатор Azure-аренды. Используйте при аутентификации с принципалом службы.
type_handler_version строка		Версия типа обработчика расширения.
virtual_machine_extension_type строка		Тип обработчика расширения.
virtual_machine_name строка		Имя виртуальной машины, где расширение должно быть создано или обновлено.

Примечания

Примечание

Для аутентификации в Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или книги задач с помощью az login.
Аутентификация также возможна с помощью принципала службы или пользователя 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 в среде.

См. также

Вход в систему с помощью Azure CLI: Как войти в систему, используя команду az login.

Примеры

- name: Create VM Extension
  community.azure.azure_rm_virtualmachineextension:
    name: myvmextension
    location: eastus
    resource_group: myResourceGroup
    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
  community.azure.azure_rm_virtualmachineextension:
    name: myvmextension
    location: eastus
    resource_group: myResourceGroup
    virtual_machine_name: myvm
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
changed булево	всегда	Изменился ли ресурс. Пример: True
state словарь	всегда	Текущее состояние расширения ВМ. Пример: {'state': 'Удалено'}

Авторы

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.10/collections/community/azure/azure_rm_virtualmachine_extension_module.html