azure.azcollection.azure_rm_image_info – Получение сведений о пользовательских изображениях Azure

Примечание

Этот плагин входит в состав коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в книге задач укажите: azure.azcollection.azure_rm_image_info.

Новое в версии 0.0.1: из azure.azcollection

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

Обзор

Список пользовательских изображений Azure. Изображения можно перечислять, используя подписку, группу ресурсов, имя или теги в качестве области перечисления.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлено в 0.0.1 коллекции azure.azcollection		URL-адрес полномочий Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственных полномочий ADFS.
api_profile строка добавлено в 0.0.1 коллекции azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлено в 0.0.1 коллекции azure.azcollection	Варианты: auto ← cli credential_file env msi	Определяет источник учетных данных для аутентификации. Также может быть задан через переменную среды `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.
... (остальные строки таблицы)

Примечания

Примечание

Для аутентификации с 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 строка	успех	Тип кэширования диска данных. Пример: read_only
		disk_size_gb целое число	всегда	Указывает размер пустых дисков данных в гигабайтах. Пример: 50
		lun целое число	всегда	Указывает логический номер устройства (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 сложный		успех	Словарь тегов, связанных с изображением.

Авторы

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.10/collections/azure/azcollection/azure_rm_image_info_module.html