Service Hook-Consumer

  • Artikel

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

Verwenden Sie Service Hook-Consumer, um ein Abonnement programmgesteuert zu erstellen. Das Abonnement gibt das Ereignis, den Consumer und die Aktion an.

Wählen Sie den Consumer aus den folgenden Consumern aus, den Sie in Ihrem Abonnement verwenden möchten. Weitere Informationen zu verfügbaren Diensten finden Sie unter Integrieren in Diensthooks, Verfügbare Dienste.

Azure-Servicebus

Ermöglicht die Integration mit Microsoft Azure Service Bus, einschließlich Notification Hubs.

Senden einer Nachricht an einen Notification Hub

Diese Aktion sendet eine generische Vorlagenbenachrichtigung an den angegebenen Azure Notification Hub. Weitere Informationen finden Sie in der Übersicht.

  • Consumer-ID: azureServiceBus
  • Aktions-ID: serviceBusNotificationHubSend
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Einstellungen:
    • connectionString
      • SAS-Verbindungszeichenfolge
      • Die SAS-Verbindungszeichenfolge (Shared Access Signature), die zum Herstellen einer Verbindung mit Azure Service Bus verwendet werden soll. Diese Verbindungszeichenfolge ist im Azure-Portal verfügbar.
      • Datentyp: string
      • Erforderlich: Ja
    • notificationHubName
      • Name des Benachrichtigungs-Hubs
      • Der Name des Notification Hubs, an den die Benachrichtigung gesendet werden soll. Der Name darf nur Buchstaben, Zahlen, Punkte, Bindestriche, Schrägstriche und Unterstriche enthalten. Der Name muss mit einem Buchstaben oder einer Ziffer beginnen und enden. Der Hub sollte bereits vorhanden sein.
      • Datentyp: string
      • Erforderlich: Ja
    • tagsExpression
      • Tags
      • Der Tags-Ausdruck (für bestimmte Gerätegruppen). Weitere Informationen
      • Datentyp: string
      • Erforderlich: Nein

Senden einer Nachricht an eine Service Bus-Warteschlange

Diese Aktion sendet eine JSON-Zeichenfolgendarstellung des Ereignisses an die angegebene Azure Service Bus Warteschlange. Weitere Informationen finden Sie unter Service Bus-Warteschlangen, -Artikel und -Abonnements.

  • Consumer-ID: azureServiceBus
  • Aktions-ID: serviceBusQueueSend
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Einstellungen:
    • connectionString
      • SAS-Verbindungszeichenfolge
      • Die SAS-Verbindungszeichenfolge (Shared Access Signature), die zum Herstellen einer Verbindung mit Azure Service Bus verwendet werden soll. Diese Verbindungszeichenfolge ist im Azure-Portal verfügbar.
      • Datentyp: string
      • Erforderlich: Ja
    • queueName
      • Warteschlangenname
      • Der Name der Warteschlange, an die die Nachricht gesendet werden soll. Der Name darf nur Buchstaben, Zahlen, Punkte, Bindestriche, Schrägstriche und Unterstriche enthalten. Der Name muss mit einem Buchstaben oder einer Ziffer beginnen und enden. Wenn die Warteschlange nicht vorhanden ist, wird sie erstellt, wenn die angegebene Verbindungszeichenfolge über die erforderlichen Berechtigungen verfügt.
      • Datentyp: string
      • Erforderlich: Ja
    • resourceDetailsToSend
      • Zu sendende Ressourcendetails
      • Steuern der zu sendenden Ressourcenfelder
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • messagesToSend
      • Zu sendende Nachrichten
      • Steuern der zu sendenden Nachrichten
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • detailedMessagesToSend
      • Detaillierte Zu sendende Nachrichten
      • Steuern der zu sendenden detaillierten Nachrichten
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein

Senden einer Nachricht an ein Service Bus-Thema

Diese Aktion sendet eine JSON-Zeichenfolgendarstellung des Ereignisses an das angegebene Azure Service Bus Thema. Weitere Informationen finden Sie unter Verwenden der Azure-Portal, um ein Service Bus-Thema und Abonnements für das Thema zu erstellen.

  • Consumer-ID: azureServiceBus
  • Aktions-ID: serviceBusTopicSend
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Einstellungen:
    • connectionString
      • SAS-Verbindungszeichenfolge
      • Die SAS-Verbindungszeichenfolge (Shared Access Signature), die zum Herstellen einer Verbindung mit Azure Service Bus verwendet werden soll. Diese Verbindungszeichenfolge ist im Azure-Portal verfügbar.
      • Datentyp: string
      • Erforderlich: Ja
    • topicName
      • Themenname
      • Der Name des Themas, an das die Nachricht gesendet werden soll. Der Name darf nur Buchstaben, Zahlen, Punkte, Bindestriche, Schrägstriche und Unterstriche enthalten. Der Name muss mit einem Buchstaben oder einer Ziffer beginnen und enden. Wenn das Thema nicht vorhanden ist, wird es erstellt, wenn die angegebene Verbindungszeichenfolge über die erforderlichen Berechtigungen verfügt.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • resourceDetailsToSend
      • Zu sendende Ressourcendetails
      • Steuern der zu sendenden Ressourcenfelder
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • messagesToSend
      • Zu sendende Nachrichten
      • Steuern der zu sendenden Nachrichten
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • detailedMessagesToSend
      • Detaillierte Zu sendende Nachrichten
      • Steuern der zu sendenden detaillierten Nachrichten
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein

Azure Storage

Ermöglicht die Integration mit Microsoft Azure Storage.

Einfügen einer Nachricht in eine Speicherwarteschlange

Diese Aktion fügt eine JSON-Zeichenfolgendarstellung des Ereignisses in die angegebene Azure-Speicherwarteschlange ein. Weitere Informationen finden Sie unter Was sind Azure-Warteschlangen?.

  • Consumer-ID: azureStorageQueue
  • Aktions-ID: Queue
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.commented, workitem.updated
  • Einstellungen:
    • accountName
      • Speicherkontoname
      • Der Name, der Ihrem Azure-Speicherkonto zugeordnet ist (z. B https://STORAGE_ACCOUNT_NAME.queue.core.windows.net. ).
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • accountKey
      • Speicherkontoschlüssel
      • Der Schlüssel, der Ihrem Azure-Speicherkonto zugeordnet ist.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • queueName
      • Warteschlangenname
      • Der Kleinbuchstabenname der Warteschlange, die in Azure Storage verwendet werden soll. Eine Warteschlange mit diesem Namen wird erstellt, wenn sie noch nicht vorhanden ist.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • visiTimeout
      • Timeout der Nachrichtensichtbarkeit (in Sekunden)
      • Gibt den Wert für das Sichtbarkeitstimeout in Sekunden für die in die Warteschlange eingereihte Nachricht relativ zur Serverzeit an. Der Wert muss größer oder gleich 0 sein und darf nicht größer als sieben Tage oder 604.800 Sekunden sein. Das Sichtbarkeitstimeout muss auf einen Wert festgelegt werden, der kleiner ist als der Wert für die Laufzeit der Nachricht.
      • Datentyp: Zahl
      • Erforderlich: Ja
    • ttl
      • Laufzeit der Nachricht (in Sekunden)
      • Gibt das Time-to-Live-Intervall für die Warteschlangennachricht in Sekunden an. Die maximal zulässige Laufzeit beträgt sieben Tage oder 604.800 Sekunden.
      • Datentyp: Zahl
      • Erforderlich: Ja
    • resourceDetailsToSend
      • Zu sendende Ressourcendetails
      • Steuern der zu sendenden Ressourcenfelder
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • messagesToSend
      • Zu sendende Nachrichten
      • Steuern der zu sendenden Nachrichten
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • detailedMessagesToSend
      • Detaillierte Zu sendende Nachrichten
      • Steuern der zu sendenden detaillierten Nachrichten
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein

Campfire

Campfire ähnelt dem Instant Messaging, ist aber ausschließlich für Gruppen konzipiert.

Senden einer Nachricht in einem Raum

Posten Sie eine Nachricht über das Ereignis in einem Raum in Campfire.

  • Consumer-ID: Lagerfeuer
  • Aktions-ID: postMessageToRoom
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.commented, workitem.updated
  • Einstellungen:
    • accountName
      • Kontoname
      • Kontoname wie https://{account name}.campfirenow.com
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • authToken
      • API-Authentifizierungstoken
      • API-Authentifizierungstoken für den Benutzer, von dem Nachrichten gepostet werden. Sie können dieses Token auf der Benutzerprofilseite bei Campfire abrufen.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • roomId
      • Raum
      • Raum zum Posten der Nachricht.
      • Datentyp: Zahl
      • Erforderlich: Ja
    • Showdetails
      • Senden einer detaillierten Nachricht
      • Posten Sie eine kurze oder ausführliche Nachricht über das Ereignis.
      • Datentyp: Boolesch
      • Erforderlich: Nein

Jenkins

Jenkins ist ein Continuous Integration-Server, der das kontinuierliche Erstellen und Testen von Softwareprojekten ermöglicht.

Git-Build auslösen

Löst einen Build aus, der für die Verwendung eines Git-Repositorys mithilfe des Jenkins Git-Plug-Ins konfiguriert ist.

  • Consumer-ID: jenkins
  • Aktions-ID: triggerGitBuild
  • Unterstützte Ereignisse: git.push
  • Einstellungen:
    • serverBaseUrl
      • Jenkins-Basis-URL
      • Die Basis-URL, die den Jenkins-Server hostet
      • Datentyp: uri
      • Erforderlich: Ja
    • username
      • Benutzername
      • Der Jenkins-Benutzername eines Benutzers, der den Build auslösen darf
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • password
      • Benutzer-API-Token (oder Kennwort)
      • Das API-Token des Benutzers, das auf der Jenkins-Benutzerkonfigurationsseite verfügbar ist. Das API-Token ist seit Version 1.426 neu. Für frühere Versionen von Jenkins muss das tatsächliche Benutzerkennwort angegeben werden.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja

Auslösen eines generischen Builds

Löst einen generischen Jenkins-Build aus, wobei die Jenkins-Build-URL aufgerufen wird.

  • Consumer-ID: jenkins
  • Aktions-ID: triggerGenericBuild
  • Unterstützte Ereignisse: git.push, build.complete, tfvc.checkin
  • Einstellungen:
    • serverBaseUrl
      • Jenkins-Basis-URL
      • Die Basis-URL, die den Jenkins-Server hostet
      • Datentyp: uri
      • Erforderlich: Ja
    • username
      • Benutzername
      • Der Jenkins-Benutzername eines Benutzers, der den Build auslösen darf
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • password
      • Benutzer-API-Token (oder Kennwort)
      • Das API-Token des Benutzers, das auf der Jenkins-Benutzerkonfigurationsseite verfügbar ist. Das API-Token ist seit Version 1.426 neu. Für frühere Versionen von Jenkins muss das tatsächliche Benutzerkennwort angegeben werden.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • buildName
      • Entwickeln
      • Der buildname, der ausgelöst werden soll
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • buildAuthToken
      • Buildtoken
      • Das Autorisierungstoken in Form einer Zeichenfolge, sodass nur Benutzer, die es kennen, die Builds dieses Projekts remote auslösen können.
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • buildParameterized
      • Akzeptiert Parameter
      • Gibt an, ob der Build parametrisiert ist oder nicht (Buildparameter wurden zuvor optional angegeben).
      • Datentyp: Boolesch
      • Erforderlich: Nein
    • buildParams
      • Buildparameter
      • Erstellen von Parameternamen und Werten, die durch einen Doppelpunkt getrennt sind (z. B. "param1:value1"), wobei jedes Name-Wert-Paar in einer eigenen Textzeile angezeigt wird
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein

Kato

Kato bietet einen Messagingdienst für moderne Organisationen.

Ereignis in Raum senden

Veröffentlichen eines Ereignisses in einem Kato-Raum

  • Consumer-ID: kato
  • Aktions-ID: postEventToRoom
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.commented, workitem.updated
  • Einstellungen:
    • roomToken
      • Raumtoken
      • Das Token für die Interaktion mit einem Raum mithilfe der Kato-API
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • roomName
      • Raumname
      • Raumname wie in Kato
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein

Trello

Ermöglicht die Integration mit Trello.

Erstellen einer Karte

Mit dieser Aktion wird eine Karte in einer vorhandenen Liste in Trello erstellt. Eine Karte kann eine Aufgabe, ein Problem, ein Ereignis oder so gut wie alles darstellen. Der Status einer Karte wird in der Regel durch die Liste bestimmt, in der sie sich befindet. Weitere Informationen finden Sie unter Erstellen eines Diensthakens mit Trello.

  • Consumer-ID: trello
  • Aktions-ID: createCard
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.commented, workitem.updated
  • Einstellungen:
    • userToken
      • Benutzertoken (Benötigen Sie eines? Jetzt herunterladen.)
      • Ihr Von Trello bereitgestelltes Benutzertoken. Wählen Sie den Link in der zuvor beschriebenen Aktionsbeschreibung aus, um zu erfahren, wie Sie dieses Token erhalten.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • boardId
      • Board
      • Der Name des Boards, auf dem die Trello-Karte erstellt wird.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • listId
      • List
      • Der Name der Liste, in der die Trello-Karte erstellt wird.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • Bezeichnungen
      • Bezeichnungen
      • Eine durch Trennzeichen getrennte Liste von Bezeichnungsfarben, die auf die erstellte Karte angewendet werden sollen. Gültige Bezeichnungsfarbnamen sind Rot, Orange, Gelb, Grün, Blau und Lila.
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • addToTop
      • Erstellen am Anfang der Liste
      • Gibt an, ob die Karte am Anfang der Trello-Liste anstelle des Endes erstellt werden soll.
      • Datentyp: Boolesch
      • Erforderlich: Nein

Erstelle eine Liste.

Mit dieser Aktion wird eine Liste auf einem vorhandenen Board in Trello erstellt. Eine Liste wird verwendet, um Karten auf einem Board zu organisieren und stellt in der Regel einen Zustand dar. Weitere Informationen finden Sie unter Erstellen eines Diensthakens mit Trello.

  • Consumer-ID: trello
  • Aktions-ID: createList
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.commented, workitem.updated
  • Einstellungen:
    • userToken
      • Benutzertoken (benötigen Sie eines? Jetzt herunterladen.)
      • Ihr Von Trello bereitgestelltes Benutzertoken. Wählen Sie den Link in der zuvor beschriebenen Aktionsbeschreibung aus, um zu erfahren, wie Sie dieses Token erhalten.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • boardId
      • Board
      • Der Name des Boards, auf dem die Trello-Liste erstellt wird.
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • addToBottom
      • Erstellen am unteren Rand der Platine
      • Gibt an, ob die Liste am unteren Rand der Platine anstatt am oberen Rand erstellt werden soll.
      • Datentyp: Boolesch
      • Erforderlich: Nein

webhooks

Webhooks ermöglichen die Ereigniskommunikation über HTTP.

Posten über HTTP

Diese Aktion stellt eine JSON-Objektdarstellung des Ereignisses für die angegebene URL bereit. HTTPS-Endpunkte werden aufgrund des Potenzials für private Daten in der Ereignisnutzlast empfohlen. Weitere Informationen finden Sie unter Webhooks.

  • Consumer-ID: webHooks
  • Aktions-ID: httpRequest
  • Unterstützte Ereignisse: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.commented, workitem.updated
  • Einstellungen:
    • url
      • URL
      • Die URL, an die ein HTTP POST gesendet wird.
      • Datentyp: uri
      • Erforderlich: Ja
    • httpHeaders
      • HTTP-Header
      • HTTP-Headerschlüssel und -Werte, die durch einen Doppelpunkt (z. B. "Key1:value1") getrennt sind, wobei jedes Schlüssel-Wert-Paar in einer eigenen Textzeile angezeigt wird.
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • basicAuthUsername
      • Benutzername der Standardauthentifizierung
      • Geben Sie einen Benutzernamen für die HTTP-Standardauthentifizierung ein. Die standardbasierte HTTP-Authentifizierung sendet Anmeldeinformationen in Nur-Text (unverschlüsselt), was bedeutet, dass Sie eine URL verwenden sollten, die mit "https" beginnt, um die Verschlüsselung dieser Anmeldeinformationen über SSL (Secure Transport Layer) zu ermöglichen.
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • basicAuthPassword
      • Standardauthentifizierungskennwort
      • Geben Sie ein Kennwort für die STANDARD-HTTP-Authentifizierung ein. Die standardbasierte HTTP-Authentifizierung sendet Anmeldeinformationen in Nur-Text (unverschlüsselt), was bedeutet, dass Sie eine URL verwenden sollten, die mit "https" beginnt, um die Verschlüsselung dieser Anmeldeinformationen per SSL zu aktivieren.
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • resourceDetailsToSend
      • Zu sendende Ressourcendetails
      • Steuern der zu sendenden Ressourcenfelder
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • messagesToSend
      • Zu sendende Nachrichten
      • Steuern der zu sendenden Nachrichten
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein
    • detailedMessagesToSend
      • Detaillierte Zu sendende Nachrichten
      • Steuern der zu sendenden detaillierten Nachrichten
      • Datentyp: Zeichenfolge
      • Erforderlich: Nein

Zendesk

Zendesk ist eine SaaS-Suite, die Helpdesk-Ticketing, Problemverfolgung und Kundendienstunterstützung bietet.

Erstellen eines privaten Kommentars in einem Ticket

Verwenden Sie Zendesk, um einen privaten Kommentar in einem Ticket zu erstellen.

  • Consumer-ID: zendesk
  • Aktions-ID: createPrivateComment
  • Unterstützte Ereignisse: workitem.commented
  • Einstellungen:
    • accountName
      • Kontoname
      • Zendesk-Kontoname wie https://{account name}.zendesk.com
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • username
      • Benutzername
      • Der Zendesk-Benutzername eines Benutzers, der Tickets aktualisiert
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja
    • apiToken
      • API-Token
      • Das Zendesk-API-Token (finden Sie in der Zendesk-App in Admin > Channels-API>)
      • Datentyp: Zeichenfolge
      • Erforderlich: Ja