Share via

Consommateurs de hook de service

  • Article

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

Utilisez des consommateurs de service hook pour créer un abonnement par programmation. L’abonnement spécifie l’événement, le consommateur et l’action.

Sélectionnez le consommateur que vous souhaitez utiliser dans votre abonnement parmi les consommateurs suivants. Pour plus d’informations sur les services disponibles, consultez Intégrer à des hooks de service, Services disponibles.

Azure Service Bus

Fournit une intégration à Microsoft Azure Service Bus, y compris Notification Hubs.

Envoyer un message à un hub de notification

Cette action envoie une notification de modèle générique au hub de notification Azure spécifié. Pour plus d’informations, consultez la Vue d’ensemble.

  • ID du consommateur : azureServiceBus
  • ID d’action : serviceBusNotificationHubSend
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • connectionString
      • Chaîne de connexion SAS
      • Chaîne de connexion SAS (signature d’accès partagé) à utiliser pour se connecter à Azure Service Bus. Cette chaîne de connexion est disponible dans le Portail Azure.
      • Type de données : chaîne
      • Obligatoire : Oui
    • notificationHubName
      • Nom du hub de notification
      • Nom du hub de notification à laquelle envoyer la notification. Le nom peut contenir uniquement des lettres, des chiffres, des points, des traits d’union, des barres obliques et des traits de soulignement. Le nom doit commencer et se terminer par une lettre ou un chiffre. Le hub doit déjà exister.
      • Type de données : chaîne
      • Obligatoire : Oui
    • tagsExpression
      • Étiquettes
      • Expression de balises (pour cibler des ensembles d’appareils spécifiques). Plus d’informations
      • Type de données : chaîne
      • Obligatoire : Non

Envoyer un message à une file d’attente Service Bus

Cette action envoie une représentation sous forme de chaîne JSON de l’événement à la file d’attente Azure Service Bus spécifiée. Pour plus d’informations, consultez Files d’attente, articles et abonnements Service Bus.

  • ID du consommateur : azureServiceBus
  • ID d’action : serviceBusQueueSend
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • connectionString
      • Chaîne de connexion SAS
      • Chaîne de connexion SAS (signature d’accès partagé) à utiliser pour se connecter à Azure Service Bus. Cette chaîne de connexion est disponible dans le Portail Azure.
      • Type de données : chaîne
      • Obligatoire : Oui
    • queueName
      • Nom de la file d’attente
      • Nom de la file d’attente à laquelle envoyer le message. Le nom peut contenir uniquement des lettres, des chiffres, des points, des traits d’union, des barres obliques et des traits de soulignement. Le nom doit commencer et se terminer par une lettre ou un chiffre. Si la file d’attente n’existe pas, elle est créée si la chaîne de connexion spécifiée dispose des autorisations nécessaires.
      • Type de données : chaîne
      • Obligatoire : Oui
    • resourceDetailsToSend
      • Détails de la ressource à envoyer
      • Contrôler les champs de ressource à envoyer
      • Type de données : chaîne
      • Obligatoire : Non
    • messagesToSend
      • Messages à envoyer
      • Contrôler les messages à envoyer
      • Type de données : chaîne
      • Obligatoire : Non
    • detailedMessagesToSend
      • Messages détaillés à envoyer
      • Contrôler les messages détaillés à envoyer
      • Type de données : chaîne
      • Obligatoire : Non

Envoyer un message à une rubrique Service Bus

Cette action envoie une représentation sous forme de chaîne JSON de l’événement à la rubrique Azure Service Bus spécifiée. Pour plus d’informations, consultez Utiliser la Portail Azure pour créer une rubrique Service Bus et des abonnements à la rubrique.

  • ID du consommateur : azureServiceBus
  • ID d’action : serviceBusTopicSend
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • connectionString
      • Chaîne de connexion SAS
      • Chaîne de connexion SAS (signature d’accès partagé) à utiliser pour se connecter à Azure Service Bus. Cette chaîne de connexion est disponible dans le Portail Azure.
      • Type de données : chaîne
      • Obligatoire : Oui
    • topicName
      • Nom de la rubrique
      • Nom de la rubrique à laquelle envoyer le message. Le nom peut contenir uniquement des lettres, des chiffres, des points, des traits d’union, des barres obliques et des traits de soulignement. Le nom doit commencer et se terminer par une lettre ou un chiffre. Si la rubrique n’existe pas, elle est créée si la chaîne de connexion spécifiée dispose des autorisations nécessaires.
      • Type de données : chaîne
      • Obligatoire : Oui
    • resourceDetailsToSend
      • Détails de la ressource à envoyer
      • Contrôler les champs de ressource à envoyer
      • Type de données : chaîne
      • Obligatoire : Non
    • messagesToSend
      • Messages à envoyer
      • Contrôler les messages à envoyer
      • Type de données : chaîne
      • Obligatoire : Non
    • detailedMessagesToSend
      • Messages détaillés à envoyer
      • Contrôler les messages détaillés à envoyer
      • Type de données : chaîne
      • Obligatoire : Non

Stockage Azure

Fournit l’intégration à Stockage Microsoft Azure.

Insérer un message dans une file d’attente de stockage

Cette action insère une représentation de chaîne JSON de l’événement dans la file d’attente de stockage Azure spécifiée. Pour plus d’informations, consultez Que sont les files d’attente Azure ?.

  • ID du consommateur : azureStorageQueue
  • ID d’action : en file d’attente
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • accountName
      • Nom du compte de stockage
      • Nom associé à votre compte de stockage Azure (par exemple, https://STORAGE_ACCOUNT_NAME.queue.core.windows.net).
      • Type de données : chaîne
      • Obligatoire : Oui
    • accountKey
      • Clé du compte de stockage
      • Clé associée à votre compte de stockage Azure.
      • Type de données : chaîne
      • Obligatoire : Oui
    • queueName
      • Nom de la file d’attente
      • Nom en minuscules uniquement de la file d’attente à utiliser dans stockage Azure. Une file d’attente de ce nom est créée si elle n’existe pas déjà.
      • Type de données : chaîne
      • Obligatoire : Oui
    • visiTimeout
      • Délai d’attente de visibilité des messages (en secondes)
      • Spécifie la valeur de délai d’expiration de visibilité, en secondes, pour le message en file d’attente, par rapport à l’heure du serveur. La valeur doit être supérieure ou égale à 0 et ne peut pas être supérieure à sept jours ou 604 800 secondes. Le délai d’expiration de la visibilité doit être défini sur une valeur inférieure à la valeur de durée de vie du message.
      • Type de données : nombre
      • Obligatoire : Oui
    • ttl
      • Durée de vie du message (en secondes)
      • Spécifie l’intervalle de temps de vie pour le message de file d’attente, en secondes. La durée de vie maximale autorisée est de sept jours, soit 604 800 secondes.
      • Type de données : nombre
      • Obligatoire : Oui
    • resourceDetailsToSend
      • Détails de la ressource à envoyer
      • Contrôler les champs de ressource à envoyer
      • Type de données : chaîne
      • Obligatoire : Non
    • messagesToSend
      • Messages à envoyer
      • Contrôler les messages à envoyer
      • Type de données : chaîne
      • Obligatoire : Non
    • detailedMessagesToSend
      • Messages détaillés à envoyer
      • Contrôler les messages détaillés à envoyer
      • Type de données : chaîne
      • Obligatoire : Non

Campfire

Campfire est similaire à la messagerie instantanée, mais conçu exclusivement pour les groupes.

Publier un message dans une salle

Publiez un message sur l’événement dans une salle dans Campfire.

  • ID du consommateur : feu de camp
  • ID d’action : postMessageToRoom
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • accountName
      • Nom du compte
      • Nom de compte comme https://{account name}.campfirenow.com
      • Type de données : chaîne
      • Obligatoire : Oui
    • authToken
      • Jeton d’authentification d’API
      • Jeton d’authentification d’API pour l’utilisateur à partir duquel les messages sont publiés. Vous pouvez obtenir ce jeton en visitant la page de profil utilisateur sur Campfire.
      • Type de données : chaîne
      • Obligatoire : Oui
    • roomId
      • Salle
      • Espace dans laquelle publier le message.
      • Type de données : nombre
      • Obligatoire : Oui
    • showDetails
      • Envoyer un message détaillé
      • Publiez un message court ou détaillé sur l’événement.
      • Type de données : booléen
      • Obligatoire : Non

Jenkins

Jenkins est un serveur d’intégration continue, qui permet de créer et de tester des projets logiciels en continu.

Déclencher une build Git

Déclenche une build configurée pour utiliser un dépôt Git à l’aide du plug-in Git Jenkins.

  • ID du consommateur : jenkins
  • ID d’action : triggerGitBuild
  • Événements pris en charge : git.push
  • Paramètres :
    • serverBaseUrl
      • Jenkins base URL
      • URL de base qui héberge le serveur Jenkins
      • Type de données : uri
      • Obligatoire : Oui
    • username
      • Nom d’utilisateur
      • Nom d’utilisateur Jenkins d’un utilisateur autorisé à déclencher la build
      • Type de données : chaîne
      • Obligatoire : Oui
    • mot de passe
      • Jeton d’API utilisateur (ou mot de passe)
      • Le jeton d’API de l’utilisateur, qui est disponible dans la page de configuration de l’utilisateur Jenkins. Le jeton d’API est nouveau depuis la version 1.426. Pour les versions antérieures de Jenkins, le mot de passe utilisateur réel doit être spécifié.
      • Type de données : chaîne
      • Obligatoire : Oui

Déclencher une build générique

Déclenche une build Jenkins générique, appelant l’URL de build Jenkins.

  • ID du consommateur : jenkins
  • ID d’action : triggerGenericBuild
  • Événements pris en charge : git.push, build.complete, tfvc.checkin
  • Paramètres :
    • serverBaseUrl
      • Jenkins base URL
      • URL de base qui héberge le serveur Jenkins
      • Type de données : uri
      • Obligatoire : Oui
    • username
      • Nom d’utilisateur
      • Nom d’utilisateur Jenkins d’un utilisateur autorisé à déclencher la build
      • Type de données : chaîne
      • Obligatoire : Oui
    • mot de passe
      • Jeton d’API utilisateur (ou mot de passe)
      • Le jeton d’API de l’utilisateur, qui est disponible dans la page de configuration de l’utilisateur Jenkins. Le jeton d’API est nouveau depuis la version 1.426. Pour les versions antérieures de Jenkins, le mot de passe utilisateur réel doit être spécifié.
      • Type de données : chaîne
      • Obligatoire : Oui
    • buildName
      • Build
      • Nom de build à déclencher
      • Type de données : chaîne
      • Obligatoire : Oui
    • buildAuthToken
      • Jeton de génération
      • Jeton d’autorisation sous la forme d’une chaîne afin que seuls les utilisateurs qui le connaissent puissent déclencher à distance les builds de ce projet
      • Type de données : chaîne
      • Obligatoire : Non
    • buildParameterized
      • Accepte les paramètres
      • Indique si la build est paramétrée ou non (les paramètres de build sont éventuellement spécifiés précédemment)
      • Type de données : booléen
      • Obligatoire : Non
    • buildParams
      • Paramètres de build
      • Créer des noms et des valeurs de paramètres séparés par un signe deux-points (par exemple « param1:value1 ») avec chaque paire nom-valeur apparaissant sur sa propre ligne de texte
      • Type de données : chaîne
      • Obligatoire : Non

Kato

Kato fournit un service de messagerie pour les organisations modernes.

Publier un événement dans la salle

Publie un événement dans une salle Kato

  • ID de consommateur : kato
  • ID d’action : postEventToRoom
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • roomToken
      • Jeton de salle
      • Jeton permettant d’interagir avec une salle à l’aide de l’API Kato
      • Type de données : chaîne
      • Obligatoire : Oui
    • roomName
      • Nom de la salle
      • Nom de la salle tel qu’il est vu dans Kato
      • Type de données : chaîne
      • Obligatoire : Non

Trello

Fournit l’intégration à Trello.

Créer une carte

Cette action crée une carte sur une liste existante dans Trello. Une carte peut représenter une tâche, un problème, un événement ou à peu près n’importe quoi. L’état d’une carte est généralement déterminé par la liste sur laquelle elle se trouve. Pour plus d’informations, consultez Créer un hook de service avec Trello.

  • ID du consommateur : trello
  • ID d’action : createCard
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • userToken
      • Jeton utilisateur (Vous en avez besoin ? Obtenez-le maintenant.)
      • Votre jeton d’utilisateur fourni par Trello. Sélectionnez le lien dans la description de l’action décrite précédemment pour savoir comment obtenir ce jeton.
      • Type de données : chaîne
      • Obligatoire : Oui
    • boardId
      • Board
      • Nom du tableau sur lequel la carte Trello est créée.
      • Type de données : chaîne
      • Obligatoire : Oui
    • listId
      • List
      • Nom de la liste sur laquelle la carte Trello est créée.
      • Type de données : chaîne
      • Obligatoire : Oui
    • étiquettes
      • Étiquettes
      • Liste séparée par des virgules des couleurs d’étiquette à appliquer à la carte créée. Les noms de couleur d’étiquette valides sont le rouge, l’orange, le jaune, le vert, le bleu et le violet.
      • Type de données : chaîne
      • Obligatoire : Non
    • addToTop
      • Créer au début de la liste
      • Indique si la carte doit être créée au début de la liste Trello, au lieu de la fin.
      • Type de données : booléen
      • Obligatoire : Non

Créer une liste

Cette action crée une liste sur un tableau existant dans Trello. Une liste est utilisée pour organiser des cartes sur un tableau et représente généralement un état. Pour plus d’informations, consultez Créer un hook de service avec Trello.

  • ID du consommateur : trello
  • ID d’action : createList
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • userToken
      • Jeton utilisateur (en avez besoin ? Obtenez-le maintenant.)
      • Votre jeton d’utilisateur fourni par Trello. Sélectionnez le lien dans la description de l’action décrite précédemment pour savoir comment obtenir ce jeton.
      • Type de données : chaîne
      • Obligatoire : Oui
    • boardId
      • Board
      • Nom du tableau sur lequel la liste Trello est créée.
      • Type de données : chaîne
      • Obligatoire : Oui
    • addToBottom
      • Créer en bas du tableau
      • Indique si la liste doit être créée en bas du tableau, plutôt qu’en haut.
      • Type de données : booléen
      • Obligatoire : Non

Webhooks

Les webhooks fournissent une communication d’événement via HTTP.

Publier via HTTP

Cette action publie une représentation d’objet JSON de l’événement dans l’URL spécifiée. Les points de terminaison HTTPS sont recommandés en raison du potentiel de données privées dans la charge utile de l’événement. Pour plus d’informations, consultez Webhooks.

  • ID du consommateur : webHooks
  • ID d’action : httpRequest
  • Événements pris en charge : build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Paramètres :
    • url
      • URL
      • URL à laquelle un MESSAGE HTTP est envoyé.
      • Type de données : uri
      • Obligatoire : Oui
    • httpHeaders
      • En-têtes HTTP
      • Clés et valeurs d’en-tête HTTP séparées par un signe deux-points (par exemple, « Key1:value1 ») avec chaque paire clé-valeur apparaissant sur sa propre ligne de texte.
      • Type de données : chaîne
      • Obligatoire : Non
    • basicAuthUsername
      • Nom d’utilisateur d’authentification de base
      • Entrez un nom d’utilisateur pour l’authentification HTTP standard. L’authentification HTTP de base envoie les informations d’identification en texte brut (non chiffré), ce qui signifie que vous devez utiliser une URL commençant par « https » pour activer le chiffrement de ces informations d’identification via la couche de transport sécurisée (SSL).
      • Type de données : chaîne
      • Obligatoire : Non
    • basicAuthPassword
      • Mot de passe d’authentification de base
      • Entrez un mot de passe pour l’authentification HTTP standard. L’authentification HTTP de base envoie les informations d’identification en texte brut (non chiffré), ce qui signifie que vous devez utiliser une URL commençant par « https » pour activer le chiffrement de ces informations d’identification via SSL.
      • Type de données : chaîne
      • Obligatoire : Non
    • resourceDetailsToSend
      • Détails de la ressource à envoyer
      • Contrôler les champs de ressource à envoyer
      • Type de données : chaîne
      • Obligatoire : Non
    • messagesToSend
      • Messages à envoyer
      • Contrôler les messages à envoyer
      • Type de données : chaîne
      • Obligatoire : Non
    • detailedMessagesToSend
      • Messages détaillés à envoyer
      • Contrôler les messages détaillés à envoyer
      • Type de données : chaîne
      • Obligatoire : Non

Zendesk

Zendesk est une suite SaaS qui offre des tickets de support technique, un suivi des problèmes et un support client.

Créer un commentaire privé dans un ticket

Utilisez Zendesk pour créer un commentaire privé dans un ticket.

  • ID de consommateur : zendesk
  • ID d’action : createPrivateComment
  • Événements pris en charge : workitem.commented
  • Paramètres :
    • accountName
      • Nom du compte
      • Nom du compte Zendesk, par exemple https://{account name}.zendesk.com
      • Type de données : chaîne
      • Obligatoire : Oui
    • username
      • Nom d’utilisateur
      • Nom d’utilisateur Zendesk d’un utilisateur qui met à jour les tickets
      • Type de données : chaîne
      • Obligatoire : Oui
    • apiToken
      • Jeton d’API
      • Le jeton d’API Zendesk (disponible dans l’application Zendesk dans l’API Administration > Canaux>)
      • Type de données : chaîne
      • Obligatoire : Oui