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

Примечание

Этот плагин входит в сборку community.azure (версия 1.0.0).

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

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

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

Описание

Создание, обновление и удаление расширения виртуальной машины 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` может использоваться для определения идентификатора подписки, если их несколько, иначе используется стандартная подписка az 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 string	Choices: absent present ←	Состояние расширения ВМ. Используйте `present` для создания или обновления расширения ВМ и `absent` для удаления расширения ВМ.
subscription_id string		Ваш идентификатор подписки Azure.
tenant string		Идентификатор клиента Azure. Используйте при аутентификации с помощью сервисного принципала.
type_handler_version string		Версия обработчика типа расширения.
virtual_machine_extension_type string		Тип обработчика расширения.
virtual_machine_name string		Имя виртуальной машины, где должно быть создано или обновлено расширение.

Примечания

Примечание

Для аутентификации с 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 boolean	всегда	Указывает, изменился ли ресурс. Пример: True
state dictionary	всегда	Текущее состояние расширения ВМ. Пример: {'state': 'Deleted'}

Авторы

Sertac Ozercan (@sozercan)
Julien Stroheker (@julienstroheker)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_virtualmachineextension_module.html