Dela via

Tjänsthookkonsumenter

  • Artikel

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

Använd användare av tjänstkrokar för att programmatiskt skapa en prenumeration. Prenumerationen anger händelsen, konsumenten och åtgärden.

Välj den konsument som du vill använda i din prenumeration från följande konsumenter. Mer information om tillgängliga tjänster finns i Integrera med tjänstkrokar, Tillgängliga tjänster.

Azure Service Bus

Tillhandahåller integrering med Microsoft Azure Service Bus, inklusive Notification Hubs.

Skicka ett meddelande till en meddelandehubb

Den här åtgärden skickar ett allmänt mallmeddelande till den angivna Azure Notification Hub. Mer information finns i översikten.

  • Konsument-ID: azureServiceBus
  • Åtgärds-ID: serviceBusNotificationHubSend
  • Händelser som stöds: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Inställningar:
    • connectionString
      • SAS-niska veze
      • SAS (signatur för delad åtkomst) niska veze att använda för att ansluta till Azure Service Bus. Den här niska veze är tillgänglig i Azure-portalen.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • notificationHubName
      • Namn på meddelandehubb
      • Namnet på meddelandehubben som meddelandet ska skickas till. Namnet får bara innehålla bokstäver, siffror, punkter, bindestreck, snedstreck och understreck. Namnet måste börja och sluta med en bokstav eller siffra. Hubben bör redan finnas.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • tagsExpression
      • Taggar
      • Tagguttrycket (för att rikta in sig på specifika uppsättningar av enheter). Läs mer.
      • Datatyp: sträng
      • Obligatoriskt: Nej

Skicka ett meddelande till en Service Bus-kö

Den här åtgärden skickar en JSON-strängrepresentation av händelsen till den angivna Azure Service Bus-kön. Mer information finns i Service Bus-köer, artiklar och prenumerationer.

  • Konsument-ID: azureServiceBus
  • Åtgärds-ID: serviceBusQueueSend
  • Händelser som stöds: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Inställningar:
    • connectionString
      • SAS-niska veze
      • SAS (signatur för delad åtkomst) niska veze att använda för att ansluta till Azure Service Bus. Den här niska veze är tillgänglig i Azure-portalen.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • queueName
      • Könamn
      • Namnet på kön som meddelandet ska skickas till. Namnet får bara innehålla bokstäver, siffror, punkter, bindestreck, snedstreck och understreck. Namnet måste börja och sluta med en bokstav eller siffra. Om kön inte finns skapas den om den angivna niska veze har nödvändiga behörigheter.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • resourceDetailsToSend
      • Resursinformation som ska skickas
      • Kontrollera vilka resursfält som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • messagesToSend
      • Meddelanden att skicka
      • Kontrollera vilka meddelanden som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • detailedMessagesToSend
      • Detaljerade meddelanden att skicka
      • Kontrollera de detaljerade meddelanden som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej

Skicka ett meddelande till ett Service Bus-ämne

Den här åtgärden skickar en JSON-strängrepresentation av händelsen till det angivna Azure Service Bus-ämnet. Mer information finns i Använda Azure-portalen för att skapa ett Service Bus-ämne och prenumerationer på ämnet.

  • Konsument-ID: azureServiceBus
  • Åtgärds-ID: serviceBusTopicSend
  • Händelser som stöds: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Inställningar:
    • connectionString
      • SAS-niska veze
      • SAS (signatur för delad åtkomst) niska veze att använda för att ansluta till Azure Service Bus. Den här niska veze är tillgänglig i Azure-portalen.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • topicName
      • Ämnesnamn
      • Namnet på det ämne som meddelandet ska skickas till. Namnet får bara innehålla bokstäver, siffror, punkter, bindestreck, snedstreck och understreck. Namnet måste börja och sluta med en bokstav eller siffra. Om ämnet inte finns skapas det om den angivna niska veze har nödvändiga behörigheter.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • resourceDetailsToSend
      • Resursinformation som ska skickas
      • Kontrollera vilka resursfält som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • messagesToSend
      • Meddelanden att skicka
      • Kontrollera vilka meddelanden som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • detailedMessagesToSend
      • Detaljerade meddelanden att skicka
      • Kontrollera de detaljerade meddelanden som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej

Azure Storage

Tillhandahåller integrering med Microsoft Azure Storage.

Infoga ett meddelande i en lagringskö

Den här åtgärden infogar en JSON-strängrepresentation av händelsen till den angivna Azure Storage-kön. Mer information finns i Vad är Azure-köer?.

  • Konsument-ID: azureStorageQueue
  • Åtgärds-ID: enqueue
  • Händelser som stöds: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Inställningar:
    • accountName
      • Lagringskontonamn
      • Namnet som är associerat med ditt Azure Storage-konto (till exempel https://STORAGE_ACCOUNT_NAME.queue.core.windows.net).
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • accountKey
      • Lagringskontonyckel
      • Nyckeln som är associerad med ditt Azure Storage-konto.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • queueName
      • Könamn
      • Endast gemener för kön som ska användas i Azure Storage. En kö med det här namnet skapas om den inte redan finns.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • visiTimeout
      • Tidsgräns för meddelandesynlighet (i sekunder)
      • Anger tidsgränsvärdet för synlighet i sekunder för det köade meddelandet i förhållande till servertiden. Värdet måste vara större än eller lika med 0 och får inte vara större än sju dagar eller 604 800 sekunder. Tidsgränsen för synlighet måste anges till ett värde som är mindre än meddelandets time-to-live-värde.
      • Datatyp: tal
      • Obligatoriskt: Ja
    • Ttl
      • Meddelandetid till live (i sekunder)
      • Anger time-to-live-intervallet för kömeddelandet i sekunder. Den maximala tillåtna tiden till live är sju dagar, eller 604 800 sekunder.
      • Datatyp: tal
      • Obligatoriskt: Ja
    • resourceDetailsToSend
      • Resursinformation som ska skickas
      • Kontrollera vilka resursfält som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • messagesToSend
      • Meddelanden att skicka
      • Kontrollera vilka meddelanden som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • detailedMessagesToSend
      • Detaljerade meddelanden att skicka
      • Kontrollera de detaljerade meddelanden som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej

Jenkins

Jenkins är en kontinuerlig integreringsserver som gör det möjligt att skapa och testa programvaruprojekt kontinuerligt.

Utlösa Git-version

Utlöser en version som konfigurerats för att använda en Git-lagringsplats med hjälp av Jenkins Git-plugin-programmet.

  • Konsument-ID: jenkins
  • Åtgärds-ID: triggerGitBuild
  • Händelser som stöds: git.push
  • Inställningar:
    • serverBaseUrl
      • Jenkins-bas-URL
      • Bas-URL:en som är värd för Jenkins-servern
      • Datatyp: uri
      • Obligatoriskt: Ja
    • användarnamn
      • Användarnamn
      • Jenkins-användarnamnet för en användare som får utlösa bygget
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • lösenord
      • Api-token för användare (eller lösenord)
      • Användarens API-token, som är tillgänglig på jenkins-användarkonfigurationssidan. API-token är ny sedan version 1.426. För tidigare versioner av Jenkins måste det verkliga användarlösenordet anges.
      • Datatyp: sträng
      • Obligatoriskt: Ja

Utlösa allmän version

Utlöser en allmän Jenkins-version som anropar Jenkins-kompilerings-URL:en.

  • Konsument-ID: jenkins
  • Åtgärds-ID: triggerGenericBuild
  • Händelser som stöds: git.push, build.complete, tfvc.checkin
  • Inställningar:
    • serverBaseUrl
      • Jenkins-bas-URL
      • Bas-URL:en som är värd för Jenkins-servern
      • Datatyp: uri
      • Obligatoriskt: Ja
    • användarnamn
      • Användarnamn
      • Jenkins-användarnamnet för en användare som får utlösa bygget
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • lösenord
      • Api-token för användare (eller lösenord)
      • Användarens API-token, som är tillgänglig på jenkins-användarkonfigurationssidan. API-token är ny sedan version 1.426. För tidigare versioner av Jenkins måste det verkliga användarlösenordet anges.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • buildName
      • Skapa
      • Byggnamnet som ska utlösas
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • buildAuthToken
      • Byggtoken
      • Auktoriseringstoken i form av en sträng så att endast användare som känner till den kan fjärrutlösa projektets versioner
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • buildParameterized
      • Accepterar parametrar
      • Anger om bygget är parameteriserat eller inte (kompileringsparametrar har angetts tidigare)
      • Datatyp: boolesk
      • Obligatoriskt: Nej
    • buildParams
      • Byggparametrar
      • Skapa parametrars namn och värden avgränsade med ett kolon (till exempel "param1:value1") där varje namn/värde-par visas på sin egen textrad
      • Datatyp: sträng
      • Obligatoriskt: Nej

Trello

Tillhandahåller integrering med Trello.

Skapa ett kort

Den här åtgärden skapar ett kort i en befintlig lista i Trello. Ett kort kan representera en uppgift, ett problem, en händelse eller nästan vad som helst. Ett korts tillstånd bestäms vanligtvis av vilken lista det är på. Mer information finns i Skapa en tjänstkrok med Trello.

  • Konsument-ID: trello
  • Åtgärds-ID: createCard
  • Händelser som stöds: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Inställningar:
    • userToken
      • Användartoken (behöver du en? Hämta den nu.)
      • Din användartoken som tillhandahålls av Trello. Om du vill veta hur du hämtar den här token väljer du länken i den tidigare beskrivna åtgärdsbeskrivningen.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • boardId
      • Bräde
      • Namnet på tavlan där Trello-kortet skapas.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • listId
      • List
      • Namnet på listan där Trello-kortet skapas.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • Etiketter
      • Etiketter
      • En kommaavgränsad lista med etikettfärger som ska tillämpas på det skapade kortet. Giltiga etikettfärgnamn är röda, orange, gula, gröna, blå och lila.
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • addToTop
      • Skapa i början av listan
      • Anger om kortet ska skapas i början av Trello-listan i stället för i slutet.
      • Datatyp: boolesk
      • Obligatoriskt: Nej

Skapa en lista

Den här åtgärden skapar en lista på en befintlig styrelse i Trello. En lista används för att organisera kort på en tavla och representerar vanligtvis ett tillstånd. Mer information finns i Skapa en tjänstkrok med Trello.

  • Konsument-ID: trello
  • Åtgärds-ID: createList
  • Händelser som stöds: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Inställningar:
    • userToken
      • Användartoken (behöver du en? Hämta den nu.)
      • Din användartoken som tillhandahålls av Trello. Om du vill veta hur du hämtar den här token väljer du länken i den tidigare beskrivna åtgärdsbeskrivningen.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • boardId
      • Bräde
      • Namnet på tavlan som Trello-listan skapas på.
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • addToBottom
      • Skapa längst ned på tavlan
      • Anger om listan ska skapas längst ned på tavlan, i stället för överst.
      • Datatyp: boolesk
      • Obligatoriskt: Nej

Webhook

Webhooks tillhandahåller händelsekommunikation via HTTP.

Publicera via HTTP

Den här åtgärden skickar en JSON-objektrepresentation av händelsen till den angivna URL:en. HTTPS-slutpunkter rekommenderas på grund av potentialen för privata data i händelsenyttolasten. Mer information finns i Webhooks.

  • Konsument-ID: webHooks
  • Åtgärds-ID: httpRequest
  • Händelser som stöds: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Inställningar:
    • URL
      • webbadress
      • Den URL som ett HTTP POST skickas till.
      • Datatyp: uri
      • Obligatoriskt: Ja
    • httpHeaders
      • HTTP-rubriker
      • HTTP-huvudnycklar och värden avgränsade med ett kolon (till exempel "Key1:value1") där varje nyckel/värde-par visas på sin egen textrad.
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • basicAuthUsername
      • Användarnamn för grundläggande autentisering
      • Ange ett användarnamn för standard-HTTP-autentisering. Grundläggande HTTP-autentisering skickar autentiseringsuppgifter i oformaterad text (okrypterad) vilket innebär att du bör använda en URL som börjar med "https" för att aktivera kryptering av dessa autentiseringsuppgifter via SSL (Secure Transport Layer).
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • basicAuthPassword
      • Grundläggande autentiseringslösenord
      • Ange ett lösenord för http-standardautentisering. Grundläggande HTTP-autentisering skickar autentiseringsuppgifter i klartext (okrypterad) vilket innebär att du bör använda en URL som börjar med "https" för att aktivera kryptering av dessa autentiseringsuppgifter via SSL.
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • resourceDetailsToSend
      • Resursinformation som ska skickas
      • Kontrollera vilka resursfält som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • messagesToSend
      • Meddelanden att skicka
      • Kontrollera vilka meddelanden som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej
    • detailedMessagesToSend
      • Detaljerade meddelanden att skicka
      • Kontrollera de detaljerade meddelanden som ska skickas
      • Datatyp: sträng
      • Obligatoriskt: Nej

Zendesk

Zendesk är en SaaS-svit som erbjuder supportärenden, ärendespårning och kundtjänstsupport.

Skapa en privat kommentar i ett ärende

Använd Zendesk för att skapa en privat kommentar i ett ärende.

  • Konsument-ID: zendesk
  • Åtgärds-ID: createPrivateComment
  • Händelser som stöds: workitem.commented
  • Inställningar:
    • accountName
      • Kontonamn
      • Zendesk-kontonamn som https://{account name}.zendesk.com
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • användarnamn
      • Användarnamn
      • Zendesk-användarnamnet för en användare som uppdaterar biljetter
      • Datatyp: sträng
      • Obligatoriskt: Ja
    • apiToken
      • API token (API-token)
      • Zendesk API-token (finns i Zendesk-appen i API för administratörskanaler > > )
      • Datatyp: sträng
      • Obligatoriskt: Ja