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

Примечание

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

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

Для использования в плейбуке укажите: community.azure.azure_rm_image_facts.

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

Описание

Список пользовательских образов 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. Также возможно добавление дополнительных профилей. Укажите профиль, передав profile или установив 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_image_facts_module.html