Модуль azure.azcollection.azure_rm_image_info – Получение фактов об пользовательских изображениях Azure
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможна предварительная установка этой коллекции, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. Требования.
Для использования в плейбуке укажите: azure.azcollection.azure_rm_image_info.
Новая версия в azure.azcollection 0.0.1
Описание
- Список пользовательских изображений Azure. Изображения можно перечислить, основываясь на подписке, группе ресурсов, имени или тегах.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy.
- Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection.
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
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. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого параметра в значение true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных узла из https://login.microsoft.com/ для проверки узла. Установив это значение в **True**, проверка узла отключается. В результате крайне важно убедиться, что настроенный узел является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Имя образа для фильтрации из существующих образов. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string | Имя группы ресурсов. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags list / elements=string | Ограничьте результаты, предоставив список тегов. Отформатируйте теги как «ключ» или «ключ:значение». |
tenant string | Идентификатор Azure-аренды. Используется при аутентификации с помощью сервисного принципала. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью сервисного принципала. Требуется, если определён параметр x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к X509-сертификату, используемому для создания сервисного принципала в формате PEM. Сертификат должен быть присоединён к закрытому ключу. Используется при аутентификации с помощью сервисного принципала. |
Примечания
Примечание
- Для аутентификации в 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: List images with name
azure_rm_image_info:
name: test-image
resource_group: myResourceGroup
- name: List images by resource group
azure_rm_image_info:
resource_group: myResourceGroup
tags:
- testing
- foo:bar
- name: List all available images under current subscription
azure_rm_image_info:
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
images сложный | Список словарей изображений. Возвращается: всегда |
|
data_disks сложный |
Список дисков данных, связанных с изображением. Возвращается: всегда |
|
blob_uri строка |
Виртуальный жёсткий диск. Возвращается: всегда |
|
caching строка |
Тип кэширования диска данных. Возвращается: всегда Пример: |
|
disk_size_gb целое число |
Указывает размер пустых дисков данных в гигабайтах. Возвращается: всегда Пример: |
|
lun целое число |
Указывает логический номер устройства диска данных. Возвращается: всегда Пример: |
|
managed_disk_id строка |
Идентификатор управляемого диска. Возвращается: всегда Пример: |
|
storage_account_type строка |
Указывает тип хранилища учетной записи для диска данных управляемого диска. Возвращается: всегда Пример: |
|
hyper_v_generation строка |
Поколение гипервизора виртуальной машины, созданной из образа. Возвращается: всегда Пример: |
|
id строка |
Идентификатор изображения. Возвращается: всегда Пример: |
|
location строка |
Расположение изображения. Возвращается: всегда |
|
name строка |
Имя изображения. Возвращается: всегда Пример: |
|
os_disk строка |
Идентификатор диска ОС для изображения. Возвращается: всегда Пример: |
|
os_disk_caching строка |
Указывает требования к кэшированию для изображения. Возвращается: всегда |
|
os_state строка |
Указывает состояние операционной системы изображения. Возможные значения Возвращается: всегда Пример: |
|
os_storage_account_type строка |
Указывает тип хранилища учетной записи для управляемого диска. Возвращается: всегда Пример: |
|
os_type строка |
Тип ОС для изображения. Возвращается: всегда Пример: |
|
provisioning_state строка |
Состояние изображения. Возвращается: всегда Пример: |
|
resource_group string |
Группа ресурсов изображения. Возвращается: всегда Пример: |
|
source string |
Идентификатор ресурса исходной виртуальной машины, из которой создано изображение. Возвращается: всегда Пример: |
|
tags dictionary |
Словарь тегов, связанных с изображением. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_image_info_module.html