Consumer degli hook del servizio

  • Articolo

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

Usare i consumer di hook del servizio per creare una sottoscrizione a livello di codice. La sottoscrizione specifica l'evento, il consumer e l'azione.

Selezionare il consumer che si vuole usare nella sottoscrizione dai consumer seguenti. Per altre informazioni sui servizi disponibili, vedere Integrazione con hook del servizio, Servizi disponibili.

Bus di servizio di Azure

Fornisce l'integrazione con bus di servizio di Microsoft Azure, inclusi Hub di notifica.

Inviare un messaggio a un hub di notifica

Questa azione invia una notifica di modello generica all'hub di notifica di Azure specificato. Per altre informazioni, vedere l'articolo sulla panoramica.

  • ID consumer: azureServiceBus
  • ID azione: serviceBusNotificationHubSend
  • Eventi supportati: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commento, workitem.updated
  • Impostazioni:
    • connectionString
      • Stringa di connessione sas
      • La firma di accesso condiviso (firma di accesso condiviso) stringa di connessione da usare per connettersi con bus di servizio di Azure. Questo stringa di connessione è disponibile nella portale di Azure.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • notificationHubName
      • Nome hub di notifica
      • Nome dell'hub di notifica a cui inviare la notifica. Il nome può contenere solo lettere, numeri, punti, trattini, barre e caratteri di sottolineatura. Il nome deve iniziare e terminare con una lettera o un numero. L'hub dovrebbe già esistere.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • tagsExpression
      • Tag
      • Espressione di tag (per la destinazione di set specifici di dispositivi). Altre informazioni.
      • Tipo di dati: string
      • Obbligatorio: No

Inviare un messaggio a una coda bus di servizio

Questa azione invia una rappresentazione di stringa JSON dell'evento alla coda di bus di servizio di Azure specificata. Per altre informazioni, vedere bus di servizio code, articoli e sottoscrizioni.

  • ID consumer: azureServiceBus
  • ID azione: serviceBusQueueSend
  • Eventi supportati: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commento, workitem.updated
  • Impostazioni:
    • connectionString
      • Stringa di connessione sas
      • La firma di accesso condiviso (firma di accesso condiviso) stringa di connessione da usare per connettersi con bus di servizio di Azure. Questo stringa di connessione è disponibile nella portale di Azure.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • queueName
      • Nome coda
      • Nome della coda a cui inviare il messaggio. Il nome può contenere solo lettere, numeri, punti, trattini, barre e caratteri di sottolineatura. Il nome deve iniziare e terminare con una lettera o un numero. Se la coda non esiste, viene creata se il stringa di connessione specificato dispone delle autorizzazioni necessarie.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • resourceDetailsToSend
      • Dettagli risorsa da inviare
      • Controllare i campi delle risorse da inviare
      • Tipo di dati: string
      • Obbligatorio: No
    • messagesToSend
      • Messaggi da inviare
      • Controllare i messaggi da inviare
      • Tipo di dati: string
      • Obbligatorio: No
    • detailedMessagesToSend
      • Messaggi dettagliati da inviare
      • Controllare i messaggi dettagliati da inviare
      • Tipo di dati: string
      • Obbligatorio: No

Inviare un messaggio a un argomento bus di servizio

Questa azione invia una rappresentazione di stringa JSON dell'evento al bus di servizio di Azure argomento specificato. Per altre informazioni, vedere Usare il portale di Azure per creare un argomento e sottoscrizioni bus di servizio all'argomento.

  • ID consumer: azureServiceBus
  • ID azione: serviceBusTopicSend
  • Eventi supportati: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commento, workitem.updated
  • Impostazioni:
    • connectionString
      • Stringa di connessione sas
      • La firma di accesso condiviso (firma di accesso condiviso) stringa di connessione da usare per connettersi con bus di servizio di Azure. Questo stringa di connessione è disponibile nella portale di Azure.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • topicName
      • Nome argomento
      • Nome dell'argomento a cui inviare il messaggio. Il nome può contenere solo lettere, numeri, punti, trattini, barre e caratteri di sottolineatura. Il nome deve iniziare e terminare con una lettera o un numero. Se l'argomento non esiste, viene creato se il stringa di connessione specificato dispone delle autorizzazioni necessarie.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • resourceDetailsToSend
      • Dettagli risorsa da inviare
      • Controllare i campi delle risorse da inviare
      • Tipo di dati: string
      • Obbligatorio: No
    • messagesToSend
      • Messaggi da inviare
      • Controllare i messaggi da inviare
      • Tipo di dati: string
      • Obbligatorio: No
    • detailedMessagesToSend
      • Messaggi dettagliati da inviare
      • Controllare i messaggi dettagliati da inviare
      • Tipo di dati: string
      • Obbligatorio: No

Archiviazione di Azure

Fornisce l'integrazione con Archiviazione di Microsoft Azure.

Inserire un messaggio in una coda di archiviazione

Questa azione inserisce una rappresentazione di stringa JSON dell'evento nella coda di archiviazione di Azure specificata. Per altre informazioni, vedere Che cosa sono le code di Azure?.

  • ID consumer: azureStorageQueue
  • ID azione: accodamento
  • Eventi supportati: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commento, workitem.updated
  • Impostazioni:
    • accountName
      • Nome account di archiviazione
      • Nome associato all'account di archiviazione di Azure, ad esempio https://STORAGE_ACCOUNT_NAME.queue.core.windows.net.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • accountKey
      • chiave dell'account di archiviazione
      • Chiave associata all'account di archiviazione di Azure.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • queueName
      • Nome coda
      • Nome minuscolo della coda da usare nell'archiviazione di Azure. Se non esiste già, viene creata una coda con questo nome.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • visiTimeout
      • Timeout di visibilità dei messaggi (in secondi)
      • Specifica il valore di timeout di visibilità, espresso in secondi, per il messaggio accodato rispetto all'ora del server. Il valore deve essere maggiore o uguale a 0 e non può essere maggiore di sette giorni o 604.800 secondi. Il timeout della visibilità deve essere impostato su un valore inferiore al valore time-to-live del messaggio.
      • Tipo di dati: numero
      • Obbligatorio: Sì
    • Ttl
      • Durata del messaggio (in secondi)
      • Specifica l'intervallo di tempo per il messaggio della coda, espresso in secondi. Il tempo massimo consentito è di sette giorni o 604.800 secondi.
      • Tipo di dati: numero
      • Obbligatorio: Sì
    • resourceDetailsToSend
      • Dettagli risorsa da inviare
      • Controllare i campi delle risorse da inviare
      • Tipo di dati: string
      • Obbligatorio: No
    • messagesToSend
      • Messaggi da inviare
      • Controllare i messaggi da inviare
      • Tipo di dati: string
      • Obbligatorio: No
    • detailedMessagesToSend
      • Messaggi dettagliati da inviare
      • Controllare i messaggi dettagliati da inviare
      • Tipo di dati: string
      • Obbligatorio: No

Jenkins

Jenkins è un server di integrazione continua, che consente di compilare e testare continuamente progetti software.

Attivare la compilazione Git

Attiva una compilazione configurata per l'uso di un repository Git usando il plug-in Git di Jenkins.

  • ID consumer: jenkins
  • ID azione: triggerGitBuild
  • Eventi supportati: git.push
  • Impostazioni:
    • serverBaseUrl
      • Jenkins base URL
      • URL di base che ospita il server Jenkins
      • Tipo di dati: URI
      • Obbligatorio: Sì
    • username
      • Nome utente
      • Nome utente jenkins di un utente autorizzato a attivare la compilazione
      • Tipo di dati: string
      • Obbligatorio: Sì
    • password
      • Token API utente (o password)
      • Token API dell'utente, disponibile nella pagina di configurazione utente di Jenkins. Il token API è una novità dalla versione 1.426. Per le versioni precedenti di Jenkins, è necessario specificare la password utente reale.
      • Tipo di dati: string
      • Obbligatorio: Sì

Attivare la compilazione generica

Attiva una compilazione Jenkins generica, richiamando l'URL di compilazione jenkins.

  • ID consumer: jenkins
  • ID azione: triggerGenericBuild
  • Eventi supportati: git.push, build.complete, tfvc.checkin
  • Impostazioni:
    • serverBaseUrl
      • Jenkins base URL
      • URL di base che ospita il server Jenkins
      • Tipo di dati: URI
      • Obbligatorio: Sì
    • username
      • Nome utente
      • Nome utente jenkins di un utente autorizzato a attivare la compilazione
      • Tipo di dati: string
      • Obbligatorio: Sì
    • password
      • Token API utente (o password)
      • Token API dell'utente, disponibile nella pagina di configurazione utente di Jenkins. Il token API è una novità dalla versione 1.426. Per le versioni precedenti di Jenkins, è necessario specificare la password utente reale.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • buildName
      • Build
      • Nome di compilazione da attivare
      • Tipo di dati: string
      • Obbligatorio: Sì
    • buildAuthToken
      • Token di compilazione
      • Token di autorizzazione sotto forma di stringa in modo che solo gli utenti che lo conoscono siano in grado di attivare in remoto le compilazioni di questo progetto
      • Tipo di dati: string
      • Obbligatorio: No
    • buildParameterized
      • Accetta parametri
      • Indica se la compilazione è parametrizzata o meno (i parametri di compilazione vengono facoltativamente specificati in precedenza)
      • Tipo di dati: booleano
      • Obbligatorio: No
    • buildParams
      • Parametri di compilazione
      • Compilare nomi e valori di parametri separati da due punti(ad esempio "param1:value1") con ogni coppia nome-valore visualizzata sulla propria riga di testo
      • Tipo di dati: string
      • Obbligatorio: No

Trello

Fornisce l'integrazione con Trello.

Creazione di una scheda

Questa azione crea una scheda in un elenco esistente in Trello. Una scheda può rappresentare un'attività, un problema, un evento o semplicemente qualsiasi cosa. Lo stato di una scheda è in genere determinato dall'elenco in cui si trova. Per altre informazioni, vedere Creare un hook del servizio con Trello.

  • ID consumer: trello
  • ID azione: createCard
  • Eventi supportati: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commento, workitem.updated
  • Impostazioni:
    • userToken
      • Token utente (ne serve uno? Scaricalo ora.
      • Token utente fornito da Trello. Per informazioni su come ottenere questo token, selezionare il collegamento nella descrizione dell'azione descritta in precedenza.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • boardId
      • Bacheca
      • Nome della scheda in cui viene creata la scheda Trello.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • listId
      • List
      • Nome dell'elenco in cui viene creata la scheda Trello.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • Etichette
      • Etichette
      • Elenco delimitato da virgole di colori dell'etichetta da applicare alla scheda creata. I nomi dei colori delle etichette validi sono rosso, arancione, giallo, verde, blu e viola.
      • Tipo di dati: string
      • Obbligatorio: No
    • addToTop
      • Crea all'inizio dell'elenco
      • Indica se la scheda deve essere creata all'inizio dell'elenco Trello, anziché alla fine.
      • Tipo di dati: booleano
      • Obbligatorio: No

Creazione di un elenco

Questa azione crea un elenco in una scheda esistente in Trello. Un elenco viene usato per organizzare le schede in una lavagna e in genere rappresenta uno stato. Per altre informazioni, vedere Creare un hook del servizio con Trello.

  • ID consumer: trello
  • ID azione: createList
  • Eventi supportati: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commento, workitem.updated
  • Impostazioni:
    • userToken
      • Token utente (necessario? Scaricalo ora.
      • Token utente fornito da Trello. Per informazioni su come ottenere questo token, selezionare il collegamento nella descrizione dell'azione descritta in precedenza.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • boardId
      • Bacheca
      • Nome della scheda in cui viene creato l'elenco Trello.
      • Tipo di dati: string
      • Obbligatorio: Sì
    • addToBottom
      • Crea nella parte inferiore della scheda
      • Indica se l'elenco deve essere creato nella parte inferiore della scheda, anziché nella parte superiore.
      • Tipo di dati: booleano
      • Obbligatorio: No

Webhooks

I webhook forniscono la comunicazione degli eventi tramite HTTP.

Pubblicare tramite HTTP

Questa azione invia una rappresentazione dell'oggetto JSON dell'evento all'URL specificato. Gli endpoint HTTPS sono consigliati a causa del potenziale per i dati privati nel payload dell'evento. Per altre informazioni, vedere Webhook.

  • ID consumer: webhook
  • ID azione: httpRequest
  • Eventi supportati: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commento, workitem.updated
  • Impostazioni:
    • url
      • URL
      • URL a cui viene inviato un HTTP POST.
      • Tipo di dati: URI
      • Obbligatorio: Sì
    • httpHeaders
      • Intestazioni HTTP
      • Chiavi e valori di intestazione HTTP separati da due punti(ad esempio "Key1:value1") con ogni coppia chiave-valore visualizzata sulla propria riga di testo.
      • Tipo di dati: string
      • Obbligatorio: No
    • basicAuthUsername
      • Nome utente autenticazione di base
      • Immettere un nome utente per l'autenticazione HTTP standard. L'autenticazione HTTP di base invia le credenziali in testo normale (non crittografato), il che significa che è necessario usare un URL che inizia con "https" per abilitare la crittografia di queste credenziali tramite ssl (Secure Transport Layer).
      • Tipo di dati: string
      • Obbligatorio: No
    • basicAuthPassword
      • Password di autenticazione di base
      • Immettere una password per l'autenticazione HTTP standard. L'autenticazione HTTP di base invia le credenziali in testo normale (non crittografato), il che significa che è necessario usare un URL che inizia con "https" per abilitare la crittografia di queste credenziali tramite SSL.
      • Tipo di dati: string
      • Obbligatorio: No
    • resourceDetailsToSend
      • Dettagli risorsa da inviare
      • Controllare i campi delle risorse da inviare
      • Tipo di dati: string
      • Obbligatorio: No
    • messagesToSend
      • Messaggi da inviare
      • Controllare i messaggi da inviare
      • Tipo di dati: string
      • Obbligatorio: No
    • detailedMessagesToSend
      • Messaggi dettagliati da inviare
      • Controllare i messaggi dettagliati da inviare
      • Tipo di dati: string
      • Obbligatorio: No

Zendesk

Zendesk è una suite SaaS che offre ticket di supporto tecnico, rilevamento dei problemi e assistenza clienti.

Creare un commento privato in un ticket

Usare Zendesk per creare un commento privato in un ticket.

  • ID consumer: zendesk
  • ID azione: createPrivateComment
  • Eventi supportati: workitem.commento
  • Impostazioni:
    • accountName
      • Account name
      • Nome account Zendesk, ad esempio https://{account name}.zendesk.com
      • Tipo di dati: string
      • Obbligatorio: Sì
    • username
      • Nome utente
      • Nome utente zendesk di un utente che aggiorna i ticket
      • Tipo di dati: string
      • Obbligatorio: Sì
    • apiToken
      • Token API
      • Token DELL'API Zendesk (è disponibile nell'app Zendesk nell'API Canali > di amministrazione>)
      • Tipo di dati: string
      • Obbligatorio: Sì