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

Примечание

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

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

Для использования в книге задач, укажите: azure.azcollection.azure_rm_devtestlabartifact_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.
artifact_source_name строка / обязательно		Имя источника артефакта.
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.
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
  azure_rm_devtestlabartifact_info:
    resource_group: myResourceGroup
    lab_name: myLab
    artifact_source_name: myArtifactSource
    name: myArtifact

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

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

Ключ		Возвращаемое значение	Описание
artifacts сложный		всегда	Список словарей, содержащих факты для артефакта DevTest Lab.
	artifact_source_name строка	всегда	Имя источника артефакта. Пример: myArtifactSource
	description строка	всегда	Описание артефакта. Пример: Устанавливает мою программу
	file_path строка	всегда	Путь к артефакту в репозитории. Пример: Artifacts/myArtifact
	id строка	всегда	Идентификатор артефакта. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DevTestLab/labs/myLab/ar tifactSources/myArtifactSource/artifacts/myArtifact
	lab_name строка	всегда	Имя лаборатории. Пример: myLab
	name строка	всегда	Имя артефакта. Пример: myArtifact
	parameters сложный	всегда	Словарь, содержащий определения параметров артефакта.
	publisher строка	всегда	Имя издателя. Пример: MyPublisher
	resource_group строка	всегда	Имя группы ресурсов. Пример: myResourceGroup
	target_os_type строка	всегда	Тип целевой ОС. Пример: Linux
	title строка	всегда	Заголовок артефакта. Пример: Моя программа

Авторы

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