Модуль azure.azcollection.azure_rm_devtestlabartifactsource – Управление экземпляром Azure DevTest Labs Artifacts Source
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге сценариев, укажите: azure.azcollection.azure_rm_devtestlabartifactsource.
Новая функция в azure.azcollection 0.1.2
Описание
- Создание, обновление и удаление экземпляра Azure DevTest Labs Artifacts Source.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, который выполняет этот модуль, должна быть установлена коллекция azure.azcollection через Galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user string | Имя пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности. |
adfs_authority_url string added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
append_tags boolean | Используйте для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices:
|
arm_template_folder_path string | Папка, содержащая шаблоны Azure Resource Manager. |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Choices:
|
branch_ref string | Ссылка на ветку источника артефактов. |
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав Choices:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в **True**, проверка полномочий отключается. В результате важно убедиться, что настроенный узел полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды Choices:
|
display_name string | Отображаемое имя источника артефактов. |
folder_path string | Папка, содержащая артефакты. |
is_enabled boolean | Указывает, включен ли источник артефактов. Choices:
|
lab_name string / required | Название лаборатории. |
log_mode string | Аргумент родительского элемента. |
log_path string | Аргумент родительского элемента. |
name string / обязательно | Имя источника артефактов. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секретный ключ Azure. Используется при аутентификации с помощью службы. |
security_token string | Токен безопасности для аутентификации с источником артефактов. |
source_type string | Тип источника артефактов. Варианты:
|
state string | Утверждение состояния источника артефактов DevTest Labs. Используйте Варианты:
|
subscription_id string | Ваш идентификатор подписки Azure. |
tags словарь | Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные-метки объекта будут обновлены всеми предоставленными значениями. Для удаления меток установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не разрешают использование пробелов в метке. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 меток на ресурсах. |
tenant string | Идентификатор клиента Azure. Используется при аутентификации с помощью службы. |
thumbprint string добавлен в azure.azcollection 1.14.0 | Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью службы. Требуется, если определен x509_certificate_path. |
uri string | URI источника артефактов. |
x509_certificate_path путь добавлен в azure.azcollection 1.14.0 | Путь к сертификату X509, используемому для создания службы в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью службы. |
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед запуском задач или выполнения playbook с помощью
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: Create (or update) DevTest Labs Artifacts Source
azure_rm_devtestlabartifactsource:
resource_group: myrg
lab_name: mylab
name: myartifacts
uri: https://github.com/myself/myrepo.git
source_type: github
folder_path: /
security_token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
id строка | Идентификатор ресурса. Возвращается: всегда Пример: |
is_enabled логический тип | Указывает, включен ли источник артефактов. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_devtestlabartifactsource_module.html