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

Примечание

Этот плагин является частью коллекции community.azure (версия 1.0.0).

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

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

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

Обзор

Отображение пользовательских образов 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.
cert_validation_mode строка добавлено в 0.0.1 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную окружения `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 azure.azcollection	По умолчанию: "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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход в Azure CLI: Как войти в систему с помощью команды az login

Примеры

- name: List images with name
  community.azure.azure_rm_image_info:
    name: test-image
    resource_group: myResourceGroup

- name: List images by resource group
  community.azure.azure_rm_image_info:
    resource_group: myResourceGroup
    tags:
      - testing
      - foo:bar

- name: List all available images under current subscription
  community.azure.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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_image_info_module.html