azure_rm_devtestlabartifactsource – Управление источником артефактов Azure DevTest Labs

Новая в версии 2.8.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата
Статус

Обзор

Создание, обновление и удаление экземпляра источника артефактов Azure DevTest Labs.

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

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.
append_tags булево	Варианты: нет да ←	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом режиме любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
arm_template_folder_path -		Папка, содержащая шаблоны Azure Resource Manager.
auth_source строка добавлено в 2.5	Варианты: авто cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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.
branch_ref -		Ссылка на ветку источника артефактов.
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`.
display_name -		Отображаемое имя источника артефактов.
folder_path -		Папка, содержащая артефакты.
is_enabled булево	Варианты: нет да	Указывает, включён ли источник артефактов.
lab_name - / обязательно		Название лаборатории.
name - / обязательно		Имя источника артефактов.
password -		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, находящийся в файле ~/.azure/credentials.
resource_group - / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используется при аутентификации с принципалом службы.
security_token -		Токен безопасности для аутентификации с источником артефактов.
source_type -	Варианты: vso github	Тип источника артефактов.
state -	Варианты: отсутствует существует ←	Утверждение состояния источника артефактов DevTest Labs. Используйте 'существует' для создания или обновления источника артефактов DevTest Labs, а 'отсутствует' для его удаления.
subscription_id строка		Идентификатор вашей подписки Azure.
tags словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные тегов объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с принципалом службы.
uri -		URI источника артефактов.

Примечания

Примечание

Для аутентификации в 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: 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 строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/artifactsources/myartifacts
is_enabled логическое значение	всегда	Указывает, включён ли источник артефактов. Пример: True

Статус

Этот модуль не гарантирует обратную совместимость. [предварительная версия]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/azure_rm_devtestlabartifactsource_module.html