azure_rm_virtualmachinescalesetextension – Управление расширениями набора виртуальных машин масштаба Azure (VMSS)

Новая версия 2.8.

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

Обзор

Создание, обновление и удаление расширений набора виртуальных машин масштаба Azure (VMSS).

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы.
adfs_authority_url строка добавлено в 2.6		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 булево	Варианты: no yes	Автоматически ли обновлять обработчик расширения на меньшие версии.
cert_validation_mode строка добавлено в 2.5	Варианты: ignore validate	Управление поведением проверки сертификатов для Azure-конечных точек. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или взаимодействии с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно настроить через профиль файла credencial или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы.
cloud_environment строка добавлено в 2.4	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, название среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (необходимо для Azure Stack). Также можно задать через профиль файла credential или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
location -		Допустимое расположение Azure. По умолчанию — расположение группы ресурсов.
name -		Имя расширения VMSS.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
protected_settings -		Словарь, содержащий защищенные настройки расширения. Настройки зависят от типа расширения. См. https://docs.microsoft.com/ru-ru/azure/virtual-machines/extensions/overview для получения дополнительной информации.
publisher -		Имя издателя обработчика расширения.
resource_group - / обязательно		Имя группы ресурсов, в которой существует или будет создано расширение VMSS.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
settings -		Словарь, содержащий настройки расширения. Настройки зависят от типа расширения. См. https://docs.microsoft.com/ru-ru/azure/virtual-machines/extensions/overview для получения дополнительной информации.
state -	Варианты: absent present ←	Утвердить состояние расширения. Используйте `present` для создания или обновления расширения и `absent` для удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
tenant строка		Идентификатор Azure-арендатора. Используется при аутентификации с помощью принципала службы.
type -		Тип обработчика расширения.
type_handler_version -		Версия типа обработчика расширения.
vmss_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: Install VMSS Extension
  azure_rm_virtualmachinescalesetextension:
    name: myvmssextension
    location: eastus
    resource_group: myResourceGroup
    vmss_name: myvm
    publisher: Microsoft.Azure.Extensions
    type: CustomScript
    type_handler_version: 2.0
    settings: '{"commandToExecute": "hostname"}'
    auto_upgrade_minor_version: true

- name: Remove VMSS Extension
  azure_rm_virtualmachinescalesetextension:
    name: myvmssextension
    location: eastus
    resource_group: myResourceGroup
    vmss_name: myvm
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор ресурса расширения VMSS. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset/extensions/myext

Статус

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

Авторы

Zim Kalinowski (@zikalino)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_virtualmachinescalesetextension_module.html