azure_rm_virtualmachineimage_facts - Получение фактов о виртуальных образах машин.
Новое в версии 2.1.
Обзор
- Получение фактов о виртуальных образах машин.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят работать с Azure Stack. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменные среды -> профилю по умолчанию в файле учетных данных ~/.azure/credentials. При значении cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно задать через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также можно задать через профиль в файле учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
| cloud_environment (добавлен в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment или URL-адрес точки входа обнаружения метаданных (необходим для Azure Stack). Также можно задать через профиль в файле учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| location обязательно | Значение расположения Azure (например, westus, eastus, eastus2, northcentralus и т. д.). Передача только значения расположения вернёт список доступных издателей для данного расположения. | |
| name | Значение по умолчанию: None | Отобразить только результаты для определённой группы безопасности. |
| offer | Значение по умолчанию: None | Название предложения образа. В сочетании со значением sku позволит увидеть список доступных версий образов. |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| publisher | Значение по умолчанию: None | Название издателя образа. Список предложений образов, связанных с конкретным издателем. |
| secret | Значение по умолчанию: None | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. |
| sku | Значение по умолчанию: None | SKU предложения образа. В сочетании с offer позволит увидеть список доступных версий. |
| subscription_id | Значение по умолчанию: None | Ваш идентификатор подписки Azure. |
| tenant | Значение по умолчанию: None | Идентификатор Azure-арендатора. Используется при аутентификации с помощью сервисного принципала. |
| version | Значение по умолчанию: None | Конкретный номер версии образа. |
Примечания
Примечание
- Для аутентификации с Azure можно передать параметры, установить переменные среды или использовать профиль, хранящийся в ~/.azure/credentials. Аутентификация возможна с помощью сервисного принципала или пользователя 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 в среде.
Примеры
- name: Get facts for a specific image
azure_rm_virtualmachineimage_facts:
location: eastus
publisher: OpenLogic
offer: CentOS
sku: '7.1'
version: '7.1.20160308'
- name: List available versions
azure_rm_virtualmachineimage_facts:
location: eastus
publisher: OpenLogic
offer: CentOS
sku: '7.1'
- name: List available offers
azure_rm_virtualmachineimage_facts:
location: eastus
publisher: OpenLogic
- name: List available publishers
azure_rm_virtualmachineimage_facts:
location: eastus
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| azure_vmimages список | всегда | Список словарей с данными об образах. |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется обратной совместимости.
Автор
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_virtualmachineimage_facts_module.html
