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

Примечание

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

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

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

Новое в версии 0.1.2: из 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.
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
  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' }

Авторы

Зим Калиновский (@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.10/collections/azure/azcollection/azure_rm_devtestlabenvironment_info_module.html