azure_rm_devtestlabartifact_info – Получение фактов о компоненте Azure DevTest Lab Artifact
Новая версия 2.9.
Обзор
- Получить факты о компоненте Azure DevTest Lab Artifact.
Псевдонимы: azure_rm_devtestlabartifact_facts
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. | |
| adfs_authority_url строка добавлен в 2.6 | URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и наличии собственного сервера ADFS. | |
| api_profile строка добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для публичных облаков; будущие значения позволят работать с Azure Stack. |
| artifact_source_name строка / обязательно | Имя источника артефакта. | |
| auth_source строка добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto при отсутствии переменной.auto будет следовать стандартному приоритету параметров модуля -> переменных среды -> профилю по умолчанию в файле учетных данных ~/.azure/credentials. При значении cli, учетные данные берутся из профиля Azure CLI по умолчанию.Также можно установить через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При значении msi, хост-машина должна быть Azure-ресурсом с включённой расширенной MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID может быть использована для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. msi был добавлен в Ansible 2.6. |
| cert_validation_mode строка добавлен в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack, возможно, потребуется отключить это поведение, передав ignore. Также можно настроить через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id строка | Azure идентификатор клиента. Используется при аутентификации с помощью служебного принципала. | |
| cloud_environment строка добавлен в 2.4 | По умолчанию: "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 строка | всегда | Заголовок артефакта. Пример: Моё программное обеспечение | |
Статус
- Данный модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/azure_rm_devtestlabartifact_info_module.html