azure.azcollection.azure_rm_devtestlabartifactsource_info – Получение фактов источника артефактов Azure DevTest Lab

Примечание

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

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

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

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

Получение фактов источника артефактов Azure DevTest Lab.

Требования

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

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 строка / обязательно		Имя DevTest Lab.
name строка		Имя источника артефактов DevTest Lab.
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 DevTest Lab Artifact Source
  azure_rm_devtestlabartifactsource_info:
    resource_group: myResourceGroup
    lab_name: myLab
    name: myArtifactSource

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

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

Ключ		Возвращаемое значение	Описание
artifactsources сложный		всегда	Список словарей, содержащих факты для источника артефактов DevTest Lab.
	arm_template_folder_path строка	всегда	Папка, содержащая шаблоны Azure Resource Manager. Пример: /Environments
	display_name строка	всегда	Имя источника артефактов для отображения. Пример: Общедоступный репозиторий артефактов
	folder_path строка	всегда	Папка, содержащая артефакты. Пример: /Artifacts
	id строка	всегда	Идентификатор источника артефактов. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/ar tifactSources/myArtifactSource
	is_enabled строка	всегда	Включён ли источник артефактов. Пример: True
	lab_name строка	всегда	Имя лаборатории. Пример: myLab
	name строка	всегда	Имя источника артефактов. Пример: myArtifactSource
	provisioning_state строка	всегда	Состояние подготовки источника артефактов. Пример: Выполнено
	resource_group строка	всегда	Имя группы ресурсов. Пример: myResourceGroup
	source_type строка	всегда	Тип источника артефактов. Пример: github
	tags сложный	всегда	Теги ресурса. Пример: { 'MyTag': 'MyValue' }
	uri строка	всегда	URI источника артефактов. Пример: https://github.com/Azure/azure-devtestlab.git

Авторы

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/azure/azcollection/azure_rm_devtestlabartifactsource_info_module.html