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

Примечание

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

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

Для использования в плейбуке укажите: community.azure.azure_rm_devtestlabenvironment_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` могут использоваться для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка Azure 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 строка	всегда	Состояние развертывания. Пример: Succeeded
	tags сложный	всегда	Теги ресурса. Пример: { 'MyTag': 'MyValue' }

Авторы

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.10/collections/community/azure/azure_rm_devtestlabenvironment_facts_module.html