Tworzenie niestandardowego konsumenta dla punktów zaczepienia usługi

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Użyj punktów zaczepienia usług, aby powiadomić systemy firmy innej niż Microsoft o zdarzeniach występujących w projekcie. Niestandardowy użytkownik wysyła komunikat HTTP do punktu końcowego zdefiniowanego w manifeście rozszerzenia.

W tym artykule opisano tworzenie rozszerzenia, które implementuje przykładową usługę konsumenta, która obejmuje następujące zdarzenia i akcje.

• Obsługiwane zdarzenia, które wyzwalają następujące akcje:
  • Wypchnięty kod
  • Utworzone żądanie ściągnięcia
  • Zaktualizowano żądanie ściągnięcia
• Obsługiwane akcje do wykonania w przypadku wystąpienia zdarzeń:
  • Wysyłanie komunikatu HTTP

Aby uzyskać więcej informacji, zobacz repozytorium GitHub z przykładem rozszerzenia. Aby uzyskać listę wszystkich obsługiwanych zdarzeń, których można użyć jako wyzwalaczy dla niestandardowego rozszerzenia odbiorcy, zobacz Lista typów zdarzeń.

Jak działają haki serwisowe

Wydawcy hooków usługowych definiują zestaw zdarzeń. Subskrypcje nasłuchują zdarzeń i definiują akcje uruchamiane po wyzwoleniu zdarzenia.

Ten diagram przedstawia ogólny przepływ hooków serwisowych: wydawcy emitują zdarzenia, subskrypcje dopasowują zdarzenia, a akcje są uruchamiane po wystąpieniu dopasowania. W przykładzie z tego artykułu rozszerzenie implementuje konsumenta. W przypadku wystąpienia obsługiwanego zdarzenia skonfigurowana akcja odbiorcy wysyła komunikat HTTP do punktu końcowego określonego w manifeście rozszerzenia.

Tworzenie rozszerzenia

1. Zobacz, jak utworzyć rozszerzenie od podstaw.

2. Dodaj specyficzny wkład dotyczący niestandardowej implementacji odbiorcy do podstawowego pliku manifestu. Zobacz poniższy przykład, jak manifest powinien wyglądać po dodaniu wkładu.

{
    "manifestVersion": 1,
    "id": "samples-service-hooks-consumer",
    "version": "0.1.2",
    "name": "Service Hooks Sample",
    "description": "A simple extension that demonstrates how to contribute a consumer service into service hooks.",
    "publisher": "fabrikam",
    "public": false,
    "icons": {
        "default": "images/logo.png"
    },
    "scopes": [],
    "files": [
        {
            "path": "images",
            "addressable": true
        }
    ],
    "content": {
        "details": {
            "path": "readme.md"
        }
    },
    "categories": [
        "Developer samples"
    ],
    "targets": [
        {
            "id": "Microsoft.VisualStudio.Services"
        }
    ],
    "contributions": [
        {
            "id": "consumer",
            "type": "ms.vss-servicehooks.consumer",
            "targets": [
                "ms.vss-servicehooks.consumers"
            ],
            "properties": {
                "id": "consumer",
                "name": "Sample Consumer",
                "description": "Sample consumer service",
                "informationUrl": "https://aka.ms/vsoextensions",
                "inputDescriptors": [
                    {
                        "id": "url",
                        "isRequired": true,
                        "name": "URL",
                        "description": "URL to post event payload to",
                        "inputMode": "textbox"
                    }
                ],
                "actions": [
                    {
                        "id": "performAction",
                        "name": "Perform action",
                        "description": "Posts a standard event payload",
                        "supportedEventTypes": [
                            "git.push",
                            "git.pullrequest.created",
                            "git.pullrequest.updated"
                        ],
                        "publishEvent": {
                            "url": "{{{url}}}",
                            "resourceDetailsToSend": "all",
                            "messagesToSend": "all",
                            "detailedMessagesToSend": "all"
                        }
                    }
                ]
            }
        }
    ]
}

Dla każdego udziału w rozszerzeniu manifest definiuje następujące elementy.

• Typ udziału — usługa konsumenta (ms.vss-servicehooks.consumer) w tym przypadku.
• Element docelowy wkładu — usługi konsumenckie (ms.vss-servicehooks.consumers) w tym przypadku.
• Właściwości specyficzne dla każdego typu wkładu.

Konsumenci mają następujące właściwości.

Akcje dla konsumenta mają następujące właściwości:

3. Wdróż rozszerzenie w organizacji usługi Azure DevOps i przetestuj je.

Dalsze kroki

Treści powiązane

• użytkownicy service hook
• Dostępne usługi dla punktów zaczepienia usługi
• Programowe tworzenie subskrypcji przypinania usługi
• Testowanie i debugowanie rozszerzeń w przeglądarce
• Przykładowe repozytorium GitHub rozszerzenia
• Lista typów zdarzeń