community.azure.azure_rm_devtestlabartifactsource_info – Получение сведений об источнике артефактов Azure DevTest Lab
Примечание
Этот плагин входит в коллекцию community.azure (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install community.azure.
Для использования в плейбуке укажите: community.azure.azure_rm_devtestlabartifactsource_info.
Обзор
- Получение сведений об источнике артефактов 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 |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную окружения 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 |
| Управляет поведением проверки сертификатов для 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
community.azure.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/community/azure/azure_rm_devtestlabartifactsource_info_module.html