community.azure.azure_rm_devtestlabenvironment_info – Получение фактов среды Azure

Примечание

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

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

Чтобы использовать его в книге задач, укажите: community.azure.azure_rm_devtestlabenvironment_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`.
lab_name строка / обязательно		Имя лаборатории.
name строка		Имя среды.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
subscription_id строка		Ваш идентификатор подписки Azure.
tags список / элементы=строка		Ограничить результаты, указав список тегов. Формат тегов — 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
user_name строка / обязательно		Имя пользователя.

Примечания

Примечание

Для аутентификации с 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 Environment
  community.azure.azure_rm_devtestlabenvironment_info:
    resource_group: myResourceGroup
    lab_name: myLab
    user_name: myUser
    name: myEnvironment

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

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

Ключ		Возвращаемое	Описание
environments сложный		всегда	Список словарей, содержащих факты для среды.
	deployment_template строка	всегда	Идентификатор источника артефакта. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/mylab/art ifactSources/public environment repo/armTemplates/WebApp
	id строка	всегда	Идентификатор источника артефакта. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/sc hedules/xxxxxxxx-xxxx-xxxx-xxxxx-xxxxxxxxxxxxx/environments/myEnvironment
	lab_name строка	всегда	Имя лаборатории. Пример: myLab
	name строка	всегда	Имя среды. Пример: myEnvironment
	resource_group строка	всегда	Имя группы ресурсов. Пример: myResourceGroup
	resource_group_id строка	всегда	Идентификатор целевой группы ресурсов. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myLab-myEnvironment-982571
	state строка	всегда	Состояние развертывания. Пример: Успешно
	tags сложный	всегда	Теги ресурса. Пример: { 'MyTag': 'MyValue' }

Авторы

Zim Kalinowski (@zikalino)

© 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_devtestlabenvironment_info_module.html