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	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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 boolean	Варианты: no yes	Автоматически ли обновлять обработчик расширения между младшими версиями.
cert_validation_mode - добавлено в 2.5	Варианты: validate ignore	Управление поведением проверки сертификатов для 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 -	Варианты: absent present ←	Утверждение состояния расширения ВМ. Используйте '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 boolean	всегда	Изменился ли ресурс
state словарь	всегда	Текущее состояние расширения ВМ

Статус

Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.7/modules/azure_rm_virtualmachine_extension_module.html