Udostępnij przez


Użytkownicy wpięć usługi

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

Możesz użyć wyzwalacza usługi, aby wykonać akcję w usłudze konsumenckiej, gdy zdarzenie zachodzi w projekcie Azure DevOps. Na przykład hak usługowy może powiadomić użytkownika, gdy kompilacja się nie powiedzie.

Aby skonfigurować punkt zaczepienia usługi, należy utworzyć subskrypcję określającą zdarzenie, odbiorcę i akcję. Niektórzy użytkownicy tworzą subskrypcję w usłudze konsumenckiej, a nie w usłudze Azure DevOps. Ten artykuł zawiera informacje o ustawieniach użytkownika używanych podczas programowego tworzenia subskrypcji w usłudze Azure DevOps.

Podczas tworzenia subskrypcji w usłudze Azure DevOps możesz wybrać spośród następujących użytkowników:

Aby uzyskać informacje o tych użytkownikach i innych użytkownikach, które można zintegrować z punktami zaczepienia usług, zobacz Dostępne usługi.

Azure Service Bus

Service Bus to usługa obsługi komunikatów, która ułatwia asynchroniczną komunikację między aplikacjami i usługami. Jako odbiorca zaczepów serwisowych zapewnia integrację z kolejkami i tematami usługi Service Bus, a także z Azure Notification Hubs.

Wysyłanie komunikatu do centrum powiadomień

Ta akcja wysyła ogólne, szablonowe powiadomienie do określonej instancji Notification Hubs.

  • Identyfikator odbiorcy: azureServiceBus

  • Identyfikator akcji: serviceBusNotificationHubSend

  • Obsługiwane zdarzenia: wszystkie zdarzenia

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    connectionString Parametry połączenia sygnatury dostępu współdzielonego Parametr połączenia sygnatury dostępu współdzielonego (SAS) do połączenia z usługą Service Bus. Ta parametry połączenia jest dostępna w witrynie Azure Portal. string Tak
    notificationHubName Nazwa centrum powiadomień Nazwa centrum powiadomień do wysłania powiadomienia. Nazwa może zawierać tylko litery, cyfry, kropki, łączniki, ukośniki i podkreślenia. Nazwa musi zaczynać się i kończyć literą lub cyfrą. Koncentrator powinien już istnieć. string Tak
    tagsExpression Tagi Wyrażenie tagowe celujące w określony zestaw urządzeń. Aby uzyskać więcej informacji, zobacz Routing i formuły tagów. string Nie.

Wysyłanie komunikatu do kolejki usługi Service Bus

Ta akcja wysyła reprezentację ciągu JSON zdarzenia do określonej kolejki usługi Service Bus. Aby uzyskać więcej informacji, zobacz Kolejki, tematy i subskrypcje usługi Service Bus.

  • Identyfikator odbiorcy: azureServiceBus

  • Identyfikator akcji: serviceBusQueueSend

  • Obsługiwane zdarzenia: wszystkie zdarzenia

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    AuthenticationMechanismInputId Tryb uwierzytelniania Tryb uwierzytelniania do użycia: albo ciąg połączenia, albo połączenie z usługą. string Nie.
    ServiceConnectionInputId Połączenia usługi Azure Resource Manager Identyfikator połączenia usługi. string Nie.
    ServiceBusHostNameInputId Nazwa hosta usługi Service Bus Nazwa hosta w witrynie Azure Portal w formacie sb://<Service-Bus-name>.servicebus.windows.net. string Nie.
    connectionString Parametry połączenia sygnatury dostępu współdzielonego Ciąg połączenia SAS do użycia w celu połączenia z usługą Service Bus. Ta parametry połączenia jest dostępna w witrynie Azure Portal. string Nie.
    queueName Nazwa kolejki Nazwa kolejki do wysłania komunikatu. Nazwa może zawierać tylko litery, cyfry, kropki, łączniki, ukośniki i podkreślenia. Nazwa musi zaczynać się i kończyć literą lub cyfrą. Jeśli kolejka nie istnieje, zostanie utworzona, jeśli określona parametry połączenia ma niezbędne uprawnienia. string Tak
    bypassSerializer Wyślij jako nieserializowany ciąg Opcja wysyłania komunikatów do usługi Service Bus jako ciągów nieserializowanych zamiast jako ciągów serializowanych platformy .NET. Wybierz to ustawienie, gdy odbiorca nie jest klientem platformy .NET, na przykład gdy klient używa biblioteki klienta platformy Azure dla środowiska Node. boolean Nie.
    resourceDetailsToSend Szczegóły zasobu do wysłania Liczba pól zasobów, które mają być wysłane do kolejki. Możliwości to wszystkie pola, minimalna liczba i żadna. string Nie.
    messagesToSend Komunikaty do wysłania Typy komunikatów do wysłania do kolejki. string Nie.
    detailedMessagesToSend Szczegółowe komunikaty do wysłania Typy szczegółowych komunikatów do wysłania do kolejki. string Nie.

Wysyłanie komunikatu do wątku usługi Service Bus

Ta akcja wysyła reprezentację ciągu JSON zdarzenia do określonego tematu usługi Service Bus. Aby uzyskać więcej informacji, zobacz Tworzenie tematu i subskrypcji usługi Service Bus przy użyciu witryny Azure Portal.

  • Identyfikator odbiorcy: azureServiceBus

  • Identyfikator akcji: serviceBusTopicSend

  • Obsługiwane zdarzenia: wszystkie zdarzenia

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    AuthenticationMechanismInputId Tryb uwierzytelniania Tryb uwierzytelniania do użycia. string Nie.
    ServiceConnectionInputId Połączenia usługi Azure Resource Manager Identyfikator połączenia usługi. string Nie.
    ServiceBusHostNameInputId Nazwa hosta usługi Service Bus Nazwa hosta w witrynie Azure Portal w formacie sb://{Service-Bus-name}.servicebus.windows.net. string Nie.
    connectionString Parametry połączenia sygnatury dostępu współdzielonego Ciąg połączenia SAS do użycia w celu połączenia z usługą Service Bus. Ta parametry połączenia jest dostępna w witrynie Azure Portal. string Nie.
    topicName Nazwa tematu Nazwa tematu do wysłania wiadomości. Nazwa może zawierać tylko litery, cyfry, kropki, łączniki, ukośniki i podkreślenia. Nazwa musi zaczynać się i kończyć literą lub cyfrą. Jeśli temat nie istnieje, zostanie utworzony, jeśli określony ciąg połączenia ma niezbędne uprawnienia. string Tak
    bypassSerializer Wyślij jako nieserializowany ciąg Opcja wysyłania komunikatów do usługi Service Bus jako ciągów nieserializowanych zamiast jako ciągów serializowanych platformy .NET. Wybierz to ustawienie, gdy odbiorca nie jest klientem platformy .NET, na przykład gdy klient używa biblioteki klienta platformy Azure dla środowiska Node. boolean Nie.
    resourceDetailsToSend Szczegóły zasobu do wysłania Liczba pól zasobów do wysłania do topiku. Możliwości to wszystkie pola, minimalna liczba i żadna. string Nie.
    messagesToSend Komunikaty do wysłania Typy komunikatów do wysłania do tematu. string Nie.
    detailedMessagesToSend Szczegółowe komunikaty do wysłania Typy szczegółowych komunikatów do wysłania do tematu. string Nie.

Azure Storage

Przechowywanie to rozwiązanie do przechowywania w chmurze dla różnych rodzajów danych. Usługa Azure Queue Storage jest częścią usługi Storage, która udostępnia kolejki obsługi komunikatów, które mogą działać jako użytkownicy punktów zaczepienia usługi.

Wstawianie komunikatu do kolejki usługi Storage

Ta akcja wstawia ciąg JSON reprezentujący zdarzenie do określonej kolejki Storage. Aby uzyskać więcej informacji, zobacz Co to jest usługa Azure Queue Storage?.

  • Identyfikator odbiorcy: azureStorageQueue

  • Identyfikator akcji: enqueue

  • Obsługiwane zdarzenia: wszystkie zdarzenia

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    AuthenticationMechanismInputId Tryb uwierzytelniania Tryb uwierzytelniania do użycia. string Nie.
    ServiceConnectionInputId Połączenia usługi Azure Resource Manager Identyfikator połączenia usługi. string Nie.
    accountName Nazwa konta magazynu Nazwa skojarzona z kontem Storage. Ta nazwa jest dostępna w witrynie Azure Portal. string Tak
    accountKey Klucz konta magazynu Klucz skojarzony z kontem przechowywania. string Nie.
    queueName Nazwa kolejki Nazwa składająca się tylko z małych liter kolejki do użycia w zakresie Storage. Kolejka o tej nazwie zostanie utworzona, jeśli jeszcze nie istnieje. string Tak
    visiTimeout Limit czasu oczekiwania na widoczność wiadomości Wartość limitu czasu widoczności w sekundach dla wiadomości znajdującej się w kolejce względem czasu serwera. Wartość musi być większa lub równa 0 i nie może być większa niż siedem dni lub 604 800 sekund. Limit czasu widoczności musi być ustawiony na wartość mniejszą niż wartość czasu wygaśnięcia komunikatu. number Tak
    ttl Czas wygaśnięcia wiadomości Okres życia komunikatu kolejki w sekundach. Maksymalna wartość, której można użyć, wynosi siedem dni lub 604 800 sekund. number Tak
    resourceDetailsToSend Szczegóły zasobu do wysłania Liczba pól zasobów, które mają być wysłane do kolejki. Możliwości to wszystkie pola, minimalna liczba i żadna. string Nie.
    messagesToSend Komunikaty do wysłania Typy komunikatów do wysłania do kolejki. string Nie.
    detailedMessagesToSend Szczegółowe komunikaty do wysłania Typy szczegółowych komunikatów do wysłania do kolejki. string Nie.

Bamboo

Bamboo to serwer ciągłej integracji firmy Atlassian.

Kolejkowanie kompilacji

Ta akcja kolejkuje proces budowania Bamboo.

  • Identyfikator odbiorcy: bamboo

  • Identyfikator akcji: queueBuild

  • Obsługiwane zdarzenia: git.push, , build.completetfvc.checkin

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    serverBaseUrl Podstawowy adres URL aplikacji Bamboo Identyfikator URI zawierający nazwę hosta serwera Bamboo. uri Tak
    basicAuthCredentials Poświadczenia uwierzytelniania podstawowego Poświadczenia standardowe używane do uwierzytelniania na serwerze Bamboo. Aby uniknąć wysyłania poświadczeń w postaci zwykłego tekstu, użyj protokołu HTTPS do szyfrowania poświadczeń za pośrednictwem protokołu Transport Layer Security (TLS). Zalecamy używanie jednostek usługi i tożsamości zarządzanych w usłudze Azure DevOps. string Tak
    planName Planowanie Nazwa planu kolejkującego. string Tak

Datadog

Datadog to platforma monitorowania i analizy dla środowisk w chmurze.

Publikowanie zdarzenia w usłudze Datadog

Ta akcja powoduje utworzenie zdarzenia i odpowiednich metryk w usłudze Datadog.

  • Identyfikator odbiorcy: datadog

  • Identyfikator akcji: postEventInDatadog

  • Obsługiwane zdarzenia: wszystkie zdarzenia

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    apiKey Klucz interfejsu API usługi Datadog Klucz dostępu dla konta usługi Datadog. Klucz interfejsu API można znaleźć w portalu usługi Datadog. Przejdź do swojego profilu, a następnie wybierz Ustawienia organizacji>Klucze interfejsu API. string Tak
    accountType Typ konta usługi Datadog Typ konta usługi Datadog. Typ konta można określić na podstawie nazwy hosta adresu URL używanego przez konto usługi Datadog:
    - app.datadoghq.com: US
    - app.datadoghq.eu: EU
    - us3.datadoghq.com: US3
    - us5.datadoghq.com: US5
    - ap1.datadoghq.com: AP1
    - app.dog-gov.com: GOV
    string Tak

Grafana

Grafana to pulpit nawigacyjny typu open source i edytor grafów.

Dodawanie adnotacji do bazy danych Grafana

Ta akcja tworzy adnotację w narzędziu Grafana.

  • Identyfikator odbiorcy: grafana

  • Identyfikator akcji: addAnnotation

  • Obsługiwane zdarzenia: ms.vss-release.deployment-completed-event

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    url Grafana URL Adres URL używany do publikowania adnotacji w narzędziu Grafana. uri Tak
    apiToken Token interfejsu API Token dostępu do publikowania adnotacji w bazie danych Grafana. Aby uzyskać informacje na temat tworzenia tokenu, zobacz Create Service Account tokens and dashboards for an organization (Tworzenie tokenów i pulpitów nawigacyjnych konta usługi dla organizacji). string Tak
    tags Tagi Rozdzielona przecinkami lista tagów do użycia do dodawania adnotacji. string Tak
    annotationDeploymentDurationWindow Dodawanie adnotacji do okna czasu trwania wdrożenia Opcja konfigurowania okna czasu trwania adnotacji.
    — Po wybraniu adnotacja ma zastosowanie do czasu między rozpoczęciem a ukończeniem wdrożenia.
    Gdy nie jest wybrana, adnotacja ma zastosowanie do zakończenia wdrożenia.
    boolean Nie.
    text Tekst Spersonalizowany opis adnotacji. Jeśli to ustawienie nie zostanie określone, domyślnie opisuje wydanie i stan. To ustawienie może zawierać linki, takie jak <a href="https://www.contoso.com" target="_blank">Contoso</a>. string Nie.
    dashboardId Panel sterowania Identyfikator pulpitu nawigacyjnego, do którego dodawana jest adnotacja. Jeśli identyfikator nie zostanie określony, adnotacja zostanie dodana na poziomie globalnym. string Nie.

Jenkins

Jenkins to serwer ciągłej integracji, którego można używać do ciągłego kompilowania i testowania projektów oprogramowania.

Wyzwalaj kompilację Git

Ta akcja używa wtyczki Git dla Jenkins do wyzwalania kompilacji w repozytorium Git.

  • Identyfikator odbiorcy: jenkins

  • Identyfikator akcji: triggerGitBuild

  • Obsługiwane zdarzenia: git.push, git.pullrequest.merged

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    serverBaseUrl Podstawowy adres URL usługi Jenkins Adres URI zawierający nazwę hosta serwera Jenkins. uri Tak
    basicAuthCredentials Poświadczenia uwierzytelniania podstawowego Standardowe poświadczenia uwierzytelniania HTTP. Aby uniknąć wysyłania poświadczeń w postaci zwykłego tekstu, użyj protokołu HTTPS, aby zaszyfrować poświadczenia za pośrednictwem protokołu TLS. Zalecamy używanie jednostek usługi i tożsamości zarządzanych w usłudze Azure DevOps. string Tak
    useTfsPlugin Poziom integracji Wybrany poziom integracji, który jest jedną z dwóch wartości:
    - Wbudowany interfejs API serwera Jenkins
    — Rozszerzona integracja zapewniana przez wtyczkę usługi Azure DevOps Server, jeśli ta wtyczka jest zainstalowana na serwerze Jenkins
    string Nie.

Wyzwalanie kompilacji ogólnej

Ta akcja wyzwala ogólną kompilację serwera Jenkins, która wywołuje adres URL kompilacji serwera Jenkins.

  • Identyfikator odbiorcy: jenkins

  • Identyfikator akcji: triggerGenericBuild

  • Obsługiwane zdarzenia: git.push, , git.pullrequest.mergedbuild.complete, , tfvc.checkinms.vss-release.deployment-completed-event

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    serverBaseUrl Podstawowy adres URL usługi Jenkins Adres URI zawierający nazwę hosta serwera Jenkins. uri Tak
    basicAuthCredentials Poświadczenia uwierzytelniania podstawowego Standardowe poświadczenia uwierzytelniania HTTP. Aby uniknąć wysyłania poświadczeń w postaci zwykłego tekstu, użyj protokołu HTTPS, aby zaszyfrować poświadczenia za pośrednictwem protokołu TLS. Zalecamy używanie jednostek usługi i tożsamości zarządzanych w usłudze Azure DevOps. string Tak
    buildName Kompilacja Nazwa builda do wyzwolenia. string Tak
    useTfsPlugin Poziom integracji Wybrany poziom integracji, który jest jedną z dwóch wartości:
    - Wbudowany interfejs API serwera Jenkins
    — Rozszerzona integracja zapewniana przez wtyczkę usługi Azure DevOps Server, jeśli ta wtyczka jest zainstalowana na serwerze Jenkins
    string Nie.
    buildAuthToken Token kompilacji Token autoryzacji dla kompilacji. Tylko użytkownicy, którzy znają token, mogą zdalnie wyzwalać kompilacje. string Nie.
    buildParameterized Akceptuje parametry Opcja określająca, czy kompilacja akceptuje parametry. boolean Nie.
    buildParams Parametry kompilacji Parametry kompilacji w postaci par nazwa-wartość. W każdej parze nazwa i wartość są oddzielone dwukropkiem, takim jak <parameter>:<value>. Każda para nazwa-wartość pojawia się w osobnym wierszu. string Nie.

Slack

Slack to platforma do wyszukiwania na potrzeby komunikacji zespołowej.

Publikowanie wiadomości w kanale

Ta akcja powoduje opublikowanie komunikatu o zdarzeniu w kanale usługi Slack. Aby uzyskać więcej informacji, zobacz Tworzenie elementu zaczepienia usługi dla usługi Azure DevOps przy użyciu usługi Slack.

  • Identyfikator odbiorcy: slack

  • Identyfikator akcji: postMessageToChannel

  • Obsługiwane zdarzenia: wszystkie zdarzenia

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    url Slack webhook URL Adres URL webhook dostarczony przez Slack, do którego wysyłane są żądania HTTP POST. uri Tak

Trello

Trello to narzędzie do zarządzania projektami, które używa tablic, list i kart, aby ułatwić zespołom śledzenie przepływów pracy.

Utwórz kartę

Ta akcja powoduje utworzenie karty na istniejącej liście w aplikacji Trello. Karta może reprezentować zadanie, problem, zdarzenie lub inne elementy związane z projektem. Aby uzyskać więcej informacji, zobacz Create a service hook for Azure DevOps Services and TFS with Trello (Tworzenie elementu zaczepienia usługi dla usług Azure DevOps Services i TFS za pomocą rozwiązania Trello).

Utwórz listę

Ta akcja tworzy listę na istniejącej tablicy w aplikacji Trello. Lista służy do organizowania kart na tablicy i zazwyczaj reprezentuje stan. Aby uzyskać więcej informacji, zobacz Create a service hook for Azure DevOps Services and TFS with Trello (Tworzenie elementu zaczepienia usługi dla usług Azure DevOps Services i TFS za pomocą rozwiązania Trello).

  • Identyfikator odbiorcy: trello

  • Identyfikator akcji: createList

  • Obsługiwane zdarzenia: wszystkie zdarzenia

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    userToken Token użytkownika Token użytkownika, który zapewnia dostęp do zasobów Trello. Aby uzyskać token, przejdź do strony autoryzacji trello. string Tak
    boardId Board (płytka drukowana) Nazwa tablicy, na której zostanie utworzona lista Trello. string Tak
    addToBottom Utwórz w dolnej części tablicy Opcja wskazująca, czy należy utworzyć kartę na początku, czy na końcu tablicy. Gdy to pole to true, karta zostanie utworzona na końcu. boolean Nie.
    listName Nazwa listy Nazwa nowej listy. Domyślnie tekst opisu zdarzenia jest używany jako nazwa. Możesz użyć symboli zastępczych, aby wstawić zawartość ze zdarzenia do nazwy. Aby uzyskać więcej informacji, zobacz Create a service hook for Azure DevOps Services and TFS with Trello (Tworzenie elementu zaczepienia usługi dla usług Azure DevOps Services i TFS za pomocą rozwiązania Trello). string Nie.

Elementy webhook

Elementy webhook umożliwiają wysyłanie reprezentacji JSON zdarzenia usługi Azure DevOps do dowolnej usługi, która ma publiczny punkt końcowy.

Publikowanie za pośrednictwem protokołu HTTP

Ta akcja publikuje reprezentację obiektu JSON zdarzenia w określonym adresie URL. Zalecane są punkty końcowe HTTPS ze względu na potencjalne dane prywatne w ładunku zdarzenia. Aby uzyskać więcej informacji, zobacz Webhooks (Elementy webhook).

  • Identyfikator odbiorcy: webHooks

  • Identyfikator akcji: httpRequest

  • Obsługiwane zdarzenia: wszystkie zdarzenia

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    url adres URL Adres URL, na który należy wysłać żądanie HTTP POST. uri Tak
    acceptUntrustedCerts Akceptowanie niezaufanych certyfikatów SSL Opcja braku wymagania zaufanego certyfikatu secure Sockets Layer (SSL) dla punktu końcowego. Użyj tej opcji tylko podczas programowania i testowania. boolean Nie.
    basicAuthCredentials Poświadczenia uwierzytelniania podstawowego Standardowe poświadczenia uwierzytelniania HTTP. Aby uniknąć wysyłania poświadczeń w postaci zwykłego tekstu, użyj protokołu HTTPS, aby zaszyfrować poświadczenia za pośrednictwem protokołu TLS. Zalecamy używanie jednostek usługi i tożsamości zarządzanych w usłudze Azure DevOps. string Tak
    httpHeaders Nagłówki HTTP Klucze i wartości nagłówka HTTP jako pary typu klucz-wartość. W każdej parze klucz i wartość są oddzielone dwukropkiem, takim jak <key>:<value>. Każda para klucz-wartość znajduje się w osobnym wierszu. Te wartości są widoczne dla każdego, kto ma dostęp do subskrypcji punktu zaczepienia usługi. string Nie.
    resourceDetailsToSend Szczegóły zasobu do wysłania Liczba pól zasobów, które mają być wysłane do kolejki. Możliwości to wszystkie pola, minimalna liczba i żadna. string Nie.
    messagesToSend Komunikaty do wysłania Typy komunikatów do wysłania do kolejki. string Nie.
    detailedMessagesToSend Szczegółowe komunikaty do wysłania Typy szczegółowych komunikatów do wysłania do kolejki. string Nie.

Zendesk

Zendesk to pakiet oprogramowania jako usługi (SaaS), który oferuje zgłoszenia do systemu zgłoszeń, śledzenie problemów i wsparcie klienta.

Tworzenie prywatnego komentarza w bilecie

Ta akcja powoduje utworzenie prywatnego komentarza w zgłoszeniu Zendesk.

  • Identyfikator odbiorcy: zendesk

  • Identyfikator akcji: createPrivateComment

  • Obsługiwane zdarzenia: workitem.commented

  • Ustawienia:

    ID wejściowy Nazwa Opis Typ danych Obowiązkowy
    accountName Nazwa konta Nazwa konta Zendesk. Nazwę konta można znaleźć w adresie URL konta Zendesk, który ma format https://<account-name>.zendesk.com. string Tak
    username Nazwa użytkownika Nazwa użytkownika zendesk, który aktualizuje bilety. string Tak
    apiToken Token interfejsu API Token API Zendesk. Aby znaleźć token, przejdź do aplikacji Zendesk, a następnie wybierz Admin>kanały>Interfejs API. string Tak