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

Azure DevOps Services | Azure DevOps Server 2022 г. - Azure DevOps Server 2019 г. | TFS 2018

Веб-перехватчики предоставляют способ отправки JSON-представления события в любую службу. Вам потребуется лишь общедоступная конечная точка (HTTP или HTTPS).

Дополнительные сведения о полезных данных JSON, опубликованных этим объектом-получателем, см. в разделе События.

Предварительные требования

Только владельцы организации или администраторы коллекции проектов могут управлять веб-перехватчиками для организации.

Отправка представления JSON в службу

  1. Перейдите на страницу перехватчиков службы проекта:

    https://{orgName}/{project_name}/_settings/serviceHooks

    Снимок экрана: последняя версия страницы администрирования проекта

    Выберите Создать подписку.

  2. Выберите и настройте событие Azure DevOps Services:

    Диалоговое окно

  3. Настройте действия при возникновении события:

    Сведения о параметрах "Сведения о ресурсе для отправки", "Сообщения для отправки" и "Подробные сообщения для отправки" см. в следующих & разделах Q A.

    Диалоговое окно

  4. Протестируйте подписку на перехватчик службы и завершите работу мастера:

    Тестирование

  1. Перейдите на страницу перехватчиков служб проекта:

    https://dev.azure.com/{orgName}/{project_name}/_apps/hub/ms.vss-servicehooks-web.manageServiceHooks-project

    Снимок экрана: страница администрирования проекта

    Выберите Создать подписку.

  2. Выберите и настройте событие Azure DevOps Services:

    Диалоговое окно

  3. Настройте действия при возникновении события:

    Сведения о параметрах "Сведения о ресурсе для отправки", "Сообщения для отправки" и "Подробные сообщения для отправки" см. в следующих & разделах Q A.

    Диалоговое окно

  4. Протестируйте подписку на перехватчик службы и завершите работу мастера:

    Тестирование

Теперь веб-перехватчик настроен. Перейдите к целевой службе, чтобы просмотреть представление JSON:

Просмотр представления JSON

Цены

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

Вопросы & ответы

Вопрос. Для каких параметров следует отправлять сведения о ресурсе, сообщения для отправки и подробные сообщения для отправки?

Ответ. Они управляют размером отправленных полезных данных JSON.

Параметр Сведения о ресурсе для отправки определяет, сколько ресурсов отправляется. Значение по умолчанию — Все, но вы также можете выбрать отправку минимального (отправляет только ключевые поля, такие как URL-адрес и идентификатор) или None.

Нет и минимальный полезны в сценариях, когда вызывающему объекту не требуется много ресурсов, так как он зависит от сообщения или подробного сообщения. Нет и Минимальный также полезны по соображениям безопасности. Например, вызывающему абоненту необходимо перезвонить в Azure DevOps Services и пройти обычные проверки безопасности и разрешений, чтобы получить дополнительные сведения о ресурсе.

Пример JSON:

	{
	    "eventType": "git.push",
	    ...
	    "messages": {
	        "text": "...",
	        "html": "...",
	        "markdown": "..."
	    },
	    "detailedMessage": {
	        "text": "...",
	        "html": "...",
	        "markdown": "..."
	    },
	    "resource": {
	        "id": "...",
	        "url": "https://...",
	        "name": "...",
	        "field1:": "..."
	    }
	}	

Вопрос. Можно ли создавать подписки программными средствами?

A: Да, дополнительные сведения см. здесь.

Вопрос. Можно ли отправлять веб-перехватчики в конечные точки, отличные от HTTPS?

Ответ. Да. Однако для веб-перехватчиков рекомендуется использовать только конечные точки HTTPS. Использование HTTP означает, что существует вероятность отправки личных данных в незашифрованном виде. Сюда входят все заголовки проверки подлинности в веб-перехватчике.

Вопрос. Можно ли использовать обычную проверку подлинности при настройке веб-перехватчика, который не является HTTPS?

Ответ. Нет. При использовании обычной проверки подлинности в веб-перехватчике необходимо использовать ПРОТОКОЛ HTTPS.

Вопрос. Можно ли использовать IP-адреса localhost или специального диапазона в качестве целевых объектов веб-перехватчика?

Ответ. Нет. Веб-перехватчики не могут быть нацелены на локальный узел (замыкания на себя) илиIPv6-адресаспециального/ диапазона.