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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

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

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

Добавлено в версии 0.1.2: коллекции azure.azcollection

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

Обзор

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

Требования

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

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 строка		Имя расширения VMSS.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
protected_settings строка		Словарь, содержащий защищенные параметры расширения. Параметры зависят от типа расширения. Для получения дополнительной информации см. https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/overview.
publisher строка		Название издателя обработчика расширения.
resource_group строка / обязательно		Имя группы ресурсов, в которой существует или будет создано расширение VMSS.
secret строка		Секрет клиента Azure. Используется при аутентификации с принципалом службы.
settings строка		Словарь, содержащий параметры расширения. Параметры зависят от типа расширения. Для получения дополнительной информации см. https://docs.microsoft.com/en-us/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

Авторы

Zim Kalinowski (@zikalino)

© 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/azure/azcollection/azure_rm_virtualmachinescalesetextension_module.html