azure_rm_devtestlabcustomimage_facts – Получение фактов о пользовательской Azure DevTest Lab Image

Новая версия 2.8.

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

Обзор

Получить данные о пользовательской Azure DevTest Lab Custom Image.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
adfs_authority_url строка добавлено в 2.6		URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлено в 2.5	По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлено в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать по умолчанию приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных `~/.azure/credentials`. При установке в `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также можно установить через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` было добавлено в Ansible 2.6.
cert_validation_mode строка добавлено в 2.5	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Можно также установить через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала.
cloud_environment строка добавлено в 2.4	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки доступа для обнаружения метаданных (требуется для Azure Stack). Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
lab_name - / обязательно		Название лаборатории.
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: Get instance of Custom Image
  azure_rm_devtestlabcustomimage_facts:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myImage

- name: List instances of Custom Image in the lab
  azure_rm_devtestlabcustomimage_facts:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myImage

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ		Возвращаемое значение	Описание
custom_images сложный		всегда	Список словарей, содержащих данные для пользовательской образы.
	id строка	всегда	Идентификатор источника артефакта. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/cu stomimages/myImage
	lab_name строка	всегда	Имя лаборатории. Пример: myLab
	managed_shapshot_id строка	всегда	Идентификатор управляемого моментального снимка. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.compute/snapshots/myImage
	name строка	всегда	Имя образа. Пример: myImage
	resource_group строка	всегда	Имя группы ресурсов. Пример: myResourceGroup
	source_vm_id строка	всегда	Идентификатор исходной виртуальной машины. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx//resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/v irtualmachines/myLabVm
	tags сложный	всегда	Теги ресурса. Пример: { 'MyTag': 'MyValue' }

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Zim Kalinowski (@zikalino)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_devtestlabcustomimage_facts_module.html