azure_rm_virtualmachineimage_facts - Получение фактов о виртуальных машинах.
Новая версия с версии 2.1.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Получение фактов о виртуальных образах машин.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- azure >= 2.0.0
Параметры
| параметр | обязательно | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| ad_user | нет | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | ||
| client_id | нет | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала. | ||
| cloud_environment | нет | AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла с данными учетных записей или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| location | да | Значение расположения Azure (например, westus, eastus, eastus2, northcentralus и т. д.). Передача только значения расположения вернет список доступных издателей для этого расположения. | ||
| name | нет | Показать результаты только для определенной группы безопасности. | ||
| offer | нет | Имя предложения образа. Используйте вместе со значением sku, чтобы увидеть список доступных версий образов. | ||
| password | нет | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала. | ||
| profile | нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| publisher | нет | Имя издателя образа. Список предложений образов, связанных с конкретным издателем. | ||
| secret | нет | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | ||
| sku | нет | SKU предложения образа. Используйте вместе с offer, чтобы увидеть список доступных версий. | ||
| subscription_id | нет | Ваш идентификатор подписки Azure. | ||
| tenant | нет | Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала. | ||
| version | нет | Конкретный номер версии образа. |
Примеры
- 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 | Список словарей образов. | всегда | список |
Примечания
Примечание
- Для аутентификации с 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 в среде.
Статус
Этот модуль помечен как предварительная версия, что означает, что его интерфейс не гарантируется обратной совместимостью.
Для получения помощи в разработке модулей, если вы так решили, ознакомьтесь с Информацией сообщества и участием в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_virtualmachineimage_facts_module.html