azure_rm_image_facts – Получение сведений об Azure пользовательских образах
Новая версия с 2.8.
Обзор
- Список Azure пользовательских образов. Образы могут быть перечислены, основываясь на подписке, группе ресурсов, имени или тегах.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- 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 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды 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. |
| cert_validation_mode строка добавлен в 2.5 |
| Управляет поведением проверки сертификатов для 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. |
| name - | Имя образа для фильтрации из существующих образов. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - | Имя группы ресурсов. | |
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| subscription_id строка | Ваш идентификатор Azure-подписки. | |
| tags - | Список тегов для сопоставления. | |
| tenant строка | Идентификатор Azure-арендатора. Используется при аутентификации с помощью служебного принципала. |
Примечания
Примечание
- Для аутентификации с 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_facts:
name: test-image
resource_group: myResourceGroup
- name: List images by resource group
azure_rm_image_facts:
resource_group: myResourceGroup
tags:
- testing
- foo:bar
- name: List all available images under current subscription
azure_rm_image_facts:
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| images сложный | всегда | Список словарей изображений. | ||
| data_disks сложный | всегда | Список дисков данных, связанных с изображением. | ||
| blob_uri - | Виртуальный жесткий диск. | |||
| caching - | Тип кеширования диска данных. Пример: read_only | |||
| disk_size_gb целое число | всегда | Указывает размер пустых дисков данных в гигабайтах. Пример: 50 | ||
| lun целое число | всегда | Указывает логический номер устройства диска данных. | ||
| managed_disk_id строка | Идентификатор управляемого диска. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/xx | |||
| storage_account_type строка | Указывает тип учетной записи хранения для диска данных управляемого диска. Пример: Standard_LRS | |||
| id строка | всегда | Идентификатор изображения. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/xx | ||
| location строка | всегда | Расположение изображения. | ||
| name строка | всегда | Имя изображения. | ||
| os_disk строка | Идентификатор диска ОС для изображения. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/xx | |||
| os_disk_caching строка | всегда | Указывает требования к кешированию для изображения. | ||
| os_state строка | всегда | Указывает состояние операционной системы изображения. Возможные значения — 'Generalized' или 'Specialized'. Пример: Generalized | ||
| os_storage_account_type строка | Указывает тип учетной записи хранения для управляемого диска. Пример: Standard_LRS | |||
| os_type строка | всегда | Тип ОС для изображения. Пример: Linux | ||
| provisioning_state строка | всегда | Состояние изображения. Пример: Succeeded | ||
| resource_group строка | всегда | Группа ресурсов изображения. Пример: myResourceGroup | ||
| source строка | Идентификатор ресурса исходной виртуальной машины, из которой создается изображение Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/xx | |||
| tags сложный | Словарь тегов, связанных с изображением. | |||
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Madhura Naniwadekar (@Madhura-CSI)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_image_facts_module.html
