Модуль azure.azcollection.azure_rm_virtualmachineextension — Управляемое расширение виртуальной машины Azure

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: azure.azcollection.azure_rm_virtualmachineextension.

Новая функция в azure.azcollection 0.1.2

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

Обзор

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

Требования

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

python >= 2.7
На хосте, который выполняет модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
ad_user string	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.
adfs_authority_url string added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и собственным узлом ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. Default: `"latest"`
auth_source string added in azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Может быть также установлен через переменную среды `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"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
auto_upgrade_minor_version boolean	Должен ли обработчик расширения автоматически обновляться до незначительных версий во время развертывания. Варианты: `false` `true`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или для Azure Stack может потребоваться отключить это поведение, передав `ignore`. Может быть также установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Может быть также установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Может быть также установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (default) `true`
enable_automatic_upgrade boolean	Должен ли обработчик расширения автоматически обновляться. Варианты: `false` `true`
force_update_tag boolean added in azure.azcollection 1.10.0	Должно ли расширение обновляться или повторно запускаться, даже если не обнаружено изменений по сравнению с текущей конфигурацией. Полезно при внесении изменений в protected_settings. Варианты: `false` ← (default) `true`
location string	Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.

имя строка / обязательно	Имя расширения ВМ.
пароль строка	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
профиль строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
protected_settings словарь	Защищенные параметры расширения в формате JSON. Ранее настроенные параметры недоступны, поэтому параметр не используется для проверки идемпотентности. Если изменения в этом параметре необходимо применить, используйте вместе с force_update_tag.
издатель строка	Имя издателя обработчика расширения.
группа_ресурсов строка / обязательно	Имя группы ресурсов, где существует или будет создано расширение ВМ.
секрет строка	Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала.
параметры словарь	Публичные параметры расширения в формате JSON.
состояние строка	Состояние расширения ВМ. Используйте `present` для создания или обновления расширения ВМ и `absent` для удаления расширения ВМ. Варианты: `"absent"` `"present"` ← (по умолчанию)
идентификатор_подписки строка	Ваш идентификатор подписки Azure.
арендатор строка	Идентификатор арендатора Azure. Используется при аутентификации с помощью служебного принципала.
отпечаток строка добавлено в azure.azcollection 1.14.0	Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью служебного принципала. Требуется, если определен x509_certificate_path.
версия_обработчика_типа строка	Версия типа обработчика расширения.
тип_расширения_виртуальной_машины строка	Тип обработчика расширения.
имя_виртуальной_машины строка / обязательно	Имя виртуальной машины, где расширение должно быть создано или обновлено.
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью служебного принципала.

Примечания

Примечание

Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
Аутентификация также возможна с помощью служебного принципала или пользователя Active Directory.
Для аутентификации через служебного принципала передайте идентификатор_подписки, id_клиента, секрет и арендатор или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные можно сохранить в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Авторизация с помощью Azure CLI: Как выполнить аутентификацию, используя команду az login.

Примеры

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

Значения возврата

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

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

Авторы

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

Ссылки на коллекцию

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