модуль azure.azcollection.azure_rm_devtestlabartifact_info — получение сведений об артефактах Azure DevTest Lab

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_devtestlabartifact_info.

Добавлено в azure.azcollection 0.1.2

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 2.7
На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули azure.azcollection
Полные инструкции по установке доступны по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL-адрес центра Azure AD. Используйте при аутентификации с именем пользователя и паролем, если у вас есть собственный центр ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
artifact_source_name строка / обязательно	Имя источника артефактов.
auth_source строка добавлено в azure.azcollection 0.0.1	Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды `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`, на компьютере узла должен быть включен модуль расширения MSI для ресурса Azure. Чтобы указать идентификатор подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать `subscription_id` или переменную среды `AZURE_SUBSCRIPTION_ID`; в противном случае будет выбрана первая подписка. Параметр `msi` добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode строка добавлено в azure.azcollection 0.0.1	Определяет поведение проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав `ignore`. Значение также можно задать в профиле файла учетных данных или с помощью переменной среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery логическое значение добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если задать значение True, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра действителен и заслуживает доверия. Задается в профиле файла учетных данных или с помощью переменной среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
lab_name строка / обязательно	Имя лаборатории.
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
name строка	Имя артефакта.
oidc_token строка добавлено в azure.azcollection 3.17.0	Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions и Azure DevOps), где платформа предоставляет токен OIDC напрямую. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN`.
oidc_token_file_path путь добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ часто используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN_FILE`.
password строка	Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.
profile строка	Профиль безопасности из файла ~/.azure/credentials.
resource_group строка / обязательно	Имя группы ресурсов.
secret строка	Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
subscription_id строка	Идентификатор вашей подписки Azure.
tenant строка	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязателен, если задан параметр x509_certificate_path.
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен после закрытого ключа. Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью az login.
Также можно выполнить аутентификацию с помощью субъекта-службы или пользователя Active Directory.
Для аутентификации через OIDC передайте client_id, tenant и oidc_token либо oidc_token_file_path или задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN либо AZURE_FEDERATED_TOKEN_FILE.
Для аутентификации через субъект-службу передайте 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 строка	Описание артефакта. Возвращается: всегда Пример: `"Installs My Software"`
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 строка	Название артефакта. Возвращается: всегда Пример: `"My Software"`

Авторы

Zim Kalinowski (@zikalino)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_devtestlabartifact_info_module.html