Поделиться через

Потребители перехватчика события

  • Статья

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Использование потребителей перехватчика служб для программного создания подписки. Подписка указывает событие, потребитель и действие.

Выберите потребителя, который вы хотите использовать в подписке, из следующих потребителей. Дополнительные сведения о доступных службах см. в разделе "Интеграция с перехватчиками служб", "Доступные службы".

Служебная шина Azure

Обеспечивает интеграцию с служебная шина Microsoft Azure, включая центры уведомлений.

Отправка сообщения в Центр уведомлений

Это действие отправляет универсальное уведомление шаблона в указанный Центр уведомлений Azure. Дополнительные сведения см. в статье Использование Azure DNS для частных доменов.

  • Идентификатор потребителя: azureServiceBus
  • Идентификатор действия: serviceBusNotificationHubSend
  • Поддерживаемые события: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Параметры:
    • connectionString
      • SAS строка подключения
      • Сигнатура SAS (подписанный URL-адрес) строка подключения для подключения к Служебная шина Azure. Этот строка подключения доступен в портал Azure.
      • Тип данных: строка
      • Обязательный: Да
    • notificationHubName
      • Имя концентратора уведомлений
      • Имя концентратора уведомлений для отправки уведомления. Имя может содержать только буквы, цифры, точки, дефисы, косые черты и символы подчеркивания. Имя должно начинаться и заканчиваться буквой или цифрой. Концентратор уже должен существовать.
      • Тип данных: строка
      • Обязательный: Да
    • tagsExpression
      • Теги
      • Выражение тегов (для назначения определенных наборов устройств). Подробнее.
      • Тип данных: строка
      • Обязательный: Нет

Отправка сообщения в очередь служебная шина

Это действие отправляет строковое представление события в указанную очередь Служебная шина Azure. Дополнительные сведения см. в служебная шина очередях, статьях и подписках.

  • Идентификатор потребителя: azureServiceBus
  • Идентификатор действия: serviceBusQueueSend
  • Поддерживаемые события: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Параметры:
    • connectionString
      • SAS строка подключения
      • Сигнатура SAS (подписанный URL-адрес) строка подключения для подключения к Служебная шина Azure. Этот строка подключения доступен в портал Azure.
      • Тип данных: строка
      • Обязательный: Да
    • queueName
      • Имя очереди
      • Имя очереди для отправки сообщения. Имя может содержать только буквы, цифры, точки, дефисы, косые черты и символы подчеркивания. Имя должно начинаться и заканчиваться буквой или цифрой. Если очередь не существует, она создается, если указанный строка подключения имеет необходимые разрешения.
      • Тип данных: строка
      • Обязательный: Да
    • resourceDetailsToSend
      • Сведения о ресурсе для отправки
      • Управление полями ресурсов для отправки
      • Тип данных: строка
      • Обязательный: Нет
    • messagesToSend
      • Сообщения для отправки
      • Управление отправкой сообщений
      • Тип данных: строка
      • Обязательный: Нет
    • detailedMessagesToSend
      • Подробные сообщения для отправки
      • Управление подробными сообщениями для отправки
      • Тип данных: строка
      • Обязательный: Нет

Отправка сообщения в раздел служебная шина

Это действие отправляет строковое представление события в указанный Служебная шина Azure раздел. Дополнительные сведения см. в статье "Использование портал Azure для создания раздела служебная шина и подписок на раздел".

  • Идентификатор потребителя: azureServiceBus
  • Идентификатор действия: serviceBusTopicSend
  • Поддерживаемые события: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Параметры:
    • connectionString
      • SAS строка подключения
      • Сигнатура SAS (подписанный URL-адрес) строка подключения для подключения к Служебная шина Azure. Этот строка подключения доступен в портал Azure.
      • Тип данных: строка
      • Обязательный: Да
    • topicName
      • Имя раздела
      • Имя раздела для отправки сообщения. Имя может содержать только буквы, цифры, точки, дефисы, косые черты и символы подчеркивания. Имя должно начинаться и заканчиваться буквой или цифрой. Если раздел не существует, он создается, если указанный строка подключения имеет необходимые разрешения.
      • Тип данных: строка
      • Обязательный: Да
    • resourceDetailsToSend
      • Сведения о ресурсе для отправки
      • Управление полями ресурсов для отправки
      • Тип данных: строка
      • Обязательный: Нет
    • messagesToSend
      • Сообщения для отправки
      • Управление отправкой сообщений
      • Тип данных: строка
      • Обязательный: Нет
    • detailedMessagesToSend
      • Подробные сообщения для отправки
      • Управление подробными сообщениями для отправки
      • Тип данных: строка
      • Обязательный: Нет

Хранилище Azure

Обеспечивает интеграцию с служба хранилища Microsoft Azure.

Вставка сообщений в очередь хранилища

Это действие вставляет строковое представление события в указанную очередь хранилища Azure. Дополнительные сведения см. в статье "Что такое очереди Azure?".

  • Идентификатор потребителя: azureStorageQueue
  • Идентификатор действия: enqueue
  • Поддерживаемые события: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Параметры:
    • accountName
      • Storage account name
      • Имя, связанное с учетной записью хранения Azure (например, https://STORAGE_ACCOUNT_NAME.queue.core.windows.net).
      • Тип данных: строка
      • Обязательный: Да
    • accountKey
      • Ключ учетной записи хранения
      • Ключ, связанный с учетной записью хранения Azure.
      • Тип данных: строка
      • Обязательный: Да
    • queueName
      • Имя очереди
      • Имя очереди, доступное только в нижнем регистре, которое будет использоваться в службе хранилища Azure. Очередь по этому имени создается, если она еще не существует.
      • Тип данных: строка
      • Обязательный: Да
    • visiTimeout
      • Время ожидания видимости сообщения (в секундах)
      • Указывает значение времени ожидания видимости (в секундах) для вложенного сообщения относительно времени сервера. Значение должно быть больше или равно 0, и не может быть больше семи дней или 604 800 секунд. Время ожидания видимости должно быть установлено на значение меньше, чем значение времени ожидания сообщения.
      • Тип данных: число
      • Обязательный: Да
    • ttl
      • Время жизни сообщения (в секундах)
      • Задает интервал времени в реальном времени для сообщения очереди в секундах. Максимальный срок жизни — семь дней или 604 800 секунд.
      • Тип данных: число
      • Обязательный: Да
    • resourceDetailsToSend
      • Сведения о ресурсе для отправки
      • Управление полями ресурсов для отправки
      • Тип данных: строка
      • Обязательный: Нет
    • messagesToSend
      • Сообщения для отправки
      • Управление отправкой сообщений
      • Тип данных: строка
      • Обязательный: Нет
    • detailedMessagesToSend
      • Подробные сообщения для отправки
      • Управление подробными сообщениями для отправки
      • Тип данных: строка
      • Обязательный: Нет

Jenkins

Jenkins — это сервер непрерывной интеграции, который позволяет постоянно создавать и тестировать проекты программного обеспечения.

Активация сборки Git

Активирует сборку, настроенную для использования репозитория Git с помощью подключаемого модуля Jenkins Git.

  • Идентификатор потребителя: jenkins
  • Идентификатор действия: triggerGitBuild
  • Поддерживаемые события: git.push
  • Параметры:
    • serverBaseUrl
      • Базовый URL-адрес Jenkins
      • Базовый URL-адрес, на котором размещен сервер Jenkins
      • Тип данных: URI
      • Обязательный: Да
    • username
      • User name
      • Имя пользователя Jenkins, которому разрешено активировать сборку
      • Тип данных: строка
      • Обязательный: Да
    • пароль
      • Маркер API пользователя (или пароль)
      • Маркер API пользователя, который доступен на странице конфигурации пользователя Jenkins. Маркер API является новым с версии 1.426. Для более ранних версий Jenkins необходимо указать реальный пароль пользователя.
      • Тип данных: строка
      • Обязательный: Да

Активация универсальной сборки

Активирует универсальную сборку Jenkins, вызывая URL-адрес сборки Jenkins.

  • Идентификатор потребителя: jenkins
  • Идентификатор действия: triggerGenericBuild
  • Поддерживаемые события: git.push, build.complete, tfvc.checkin
  • Параметры:
    • serverBaseUrl
      • Базовый URL-адрес Jenkins
      • Базовый URL-адрес, на котором размещен сервер Jenkins
      • Тип данных: URI
      • Обязательный: Да
    • username
      • User name
      • Имя пользователя Jenkins, которому разрешено активировать сборку
      • Тип данных: строка
      • Обязательный: Да
    • пароль
      • Маркер API пользователя (или пароль)
      • Маркер API пользователя, который доступен на странице конфигурации пользователя Jenkins. Маркер API является новым с версии 1.426. Для более ранних версий Jenkins необходимо указать реальный пароль пользователя.
      • Тип данных: строка
      • Обязательный: Да
    • buildName
      • Сборка
      • Имя сборки для активации
      • Тип данных: строка
      • Обязательный: Да
    • buildAuthToken
      • Токен сборки
      • Маркер авторизации в виде строки, чтобы только пользователи, которые знали, что смогут удаленно активировать сборки этого проекта.
      • Тип данных: строка
      • Обязательный: Нет
    • buildParameterized
      • Принимает параметры
      • Указывает, является ли сборка параметризованной или нет (параметры сборки необязательно указаны ранее)
      • Тип данных: логический
      • Обязательный: Нет
    • buildParams
      • Параметры сборки
      • Создание имен параметров и значений, разделенных двоеточием (например, param1:value1) с каждой парой "имя-значение", отображаемой в собственной строке текста
      • Тип данных: строка
      • Обязательный: Нет

Trello

Обеспечивает интеграцию с Trello.

Создание карточки

Это действие создает карточку в существующем списке в Trello. Карточка может представлять задачу, проблему, событие или только что-нибудь. Состояние карточки обычно определяется тем, в каком списке он включен. Дополнительные сведения см. в разделе "Создание перехватчика службы" с помощью Trello.

  • Идентификатор потребителя: trello
  • Идентификатор действия: createCard
  • Поддерживаемые события: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Параметры:
    • userToken
      • Маркер пользователя (требуется? Получите его сейчас.)
      • Маркер пользователя, предоставленный Trello. Чтобы узнать, как получить этот маркер, выберите ссылку в описании ранее описанного действия.
      • Тип данных: строка
      • Обязательный: Да
    • boardId
      • Board
      • Имя доски, на которой создается карточка Trello.
      • Тип данных: строка
      • Обязательный: Да
    • listId
      • List
      • Имя списка, на котором создается карточка Trello.
      • Тип данных: строка
      • Обязательный: Да
    • метки;
      • Наклейки
      • Разделенный запятыми список цветов меток, применяемых к созданной карточке. Допустимые имена цветов меток : красный, оранжевый, желтый, зеленый, синий и фиолетовый.
      • Тип данных: строка
      • Обязательный: Нет
    • addToTop
      • Создание в начале списка
      • Указывает, следует ли создать карточку в начале списка Trello вместо конца.
      • Тип данных: логический
      • Обязательный: Нет

Создать список

Это действие создает список на существующей доске в Trello. Список используется для упорядочивания карточек на доске и обычно представляет состояние. Дополнительные сведения см. в разделе "Создание перехватчика службы" с помощью Trello.

  • Идентификатор потребителя: trello
  • Идентификатор действия: createList
  • Поддерживаемые события: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Параметры:
    • userToken
      • Маркер пользователя (нужен? Получите его сейчас.)
      • Маркер пользователя, предоставленный Trello. Чтобы узнать, как получить этот маркер, выберите ссылку в описании ранее описанного действия.
      • Тип данных: строка
      • Обязательный: Да
    • boardId
      • Board
      • Имя доски, на которой создается список Trello.
      • Тип данных: строка
      • Обязательный: Да
    • addToBottom
      • Создание в нижней части доски
      • Указывает, следует ли создать список в нижней части доски, а не сверху.
      • Тип данных: логический
      • Обязательный: Нет

Веб-перехватчики

Веб-перехватчики обеспечивают обмен данными о событиях через HTTP.

Публикация по HTTP

Это действие отправляет представление объекта JSON события в указанный URL-адрес. Конечные точки HTTPS рекомендуется использовать из-за потенциальных частных данных в полезных данных события. Дополнительные сведения см. в разделе "Веб-перехватчики".

  • Идентификатор потребителя: веб-перехватчики
  • Идентификатор действия: httpRequest
  • Поддерживаемые события: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Параметры:
    • url
      • URL
      • URL-адрес, на который отправляется HTTP POST.
      • Тип данных: URI
      • Обязательный: Да
    • httpHeaders
      • Заголовки HTTP
      • Ключи и значения заголовков HTTP, разделенные двоеточием (например, "Key1:value1") с каждой парой "ключ-значение", отображаемой в собственной строке текста.
      • Тип данных: строка
      • Обязательный: Нет
    • basicAuthUsername
      • Базовое имя пользователя проверки подлинности
      • Введите имя пользователя для стандартной проверки подлинности HTTP. Обычная проверка подлинности HTTP отправляет учетные данные в виде обычного текста (незашифрованного), что означает, что необходимо использовать URL-адрес, начинающийся с https, чтобы обеспечить шифрование этих учетных данных с помощью безопасного транспортного уровня (SSL).
      • Тип данных: строка
      • Обязательный: Нет
    • basicAuthPassword
      • Базовый пароль проверки подлинности
      • Введите пароль для стандартной проверки подлинности HTTP. Обычная проверка подлинности HTTP отправляет учетные данные в виде обычного текста (незашифрованного), что означает, что для шифрования этих учетных данных с помощью SSL следует использовать URL-адрес, начинающийся с https.
      • Тип данных: строка
      • Обязательный: Нет
    • resourceDetailsToSend
      • Сведения о ресурсе для отправки
      • Управление полями ресурсов для отправки
      • Тип данных: строка
      • Обязательный: Нет
    • messagesToSend
      • Сообщения для отправки
      • Управление отправкой сообщений
      • Тип данных: строка
      • Обязательный: Нет
    • detailedMessagesToSend
      • Подробные сообщения для отправки
      • Управление подробными сообщениями для отправки
      • Тип данных: строка
      • Обязательный: Нет

Zendesk

Zendesk — это набор SaaS, который предлагает службу технической поддержки, отслеживание проблем и поддержку обслуживания клиентов.

Создание частного комментария в билете

Используйте Zendesk для создания частного комментария в билете.

  • Идентификатор потребителя: zendesk
  • Идентификатор действия: createPrivateComment
  • Поддерживаемые события: workitem.commented
  • Параметры:
    • accountName
      • Имя учетной записи
      • Имя учетной записи Zendesk, например https://{account name}.zendesk.com
      • Тип данных: строка
      • Обязательный: Да
    • username
      • User name
      • Имя пользователя Zendesk, который обновляет билеты
      • Тип данных: строка
      • Обязательный: Да
    • apiToken
      • Токен API
      • Маркер API Zendesk (можно найти в приложении Zendesk в API каналов > администрирования>)
      • Тип данных: строка
      • Обязательный: Да