Bagikan melalui

Konsumen bagi service hook

  • Artikel

Layanan Azure DevOps | Azure DevOps Server 2022 - Azure DevOps Server 2019

Gunakan konsumen hook layanan untuk membuat langganan secara terprogram. Langganan menentukan peristiwa, konsumen, dan tindakan.

Pilih konsumen yang ingin Anda gunakan dalam langganan Anda dari konsumen berikut. Untuk informasi selengkapnya tentang layanan yang tersedia, lihat Mengintegrasikan dengan kait layanan, Layanan yang tersedia.

Azure Service Bus

Menyediakan integrasi dengan Microsoft Azure Bus Layanan, termasuk Notification Hubs.

Mengirim pesan ke Notification Hub

Tindakan ini mengirimkan pemberitahuan templat generik ke Azure Notification Hub yang ditentukan. Untuk informasi selengkapnya, lihat ringkasan.

  • ID Konsumen: azureServiceBus
  • ID Tindakan: serviceBusNotificationHubSend
  • Peristiwa yang didukung: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Pengaturan:
    • connectionString
      • string koneksi SAS
      • SAS (tanda tangan akses bersama) string koneksi digunakan untuk terhubung dengan Azure Bus Layanan. string koneksi ini tersedia di portal Azure.
      • Jenis data: string
      • Diperlukan: Ya
    • notificationHubName
      • Nama Notification Hub
      • Nama hub pemberitahuan yang akan dikirimi pemberitahuan. Nama hanya boleh berisi huruf, angka, titik, tanda hubung, garis miring, dan garis bawah. Nama harus dimulai dan diakhiri dengan huruf atau angka. Hub harus sudah ada.
      • Jenis data: string
      • Diperlukan: Ya
    • tagsExpression
      • Tag
      • Ekspresi tag (untuk menargetkan set perangkat tertentu). Pelajari selengkapnya.
      • Jenis data: string
      • Diperlukan: Tidak

Mengirim pesan ke Antrean Bus Layanan

Tindakan ini mengirimkan representasi string JSON dari peristiwa ke antrean Azure Bus Layanan yang ditentukan. Untuk informasi selengkapnya, lihat Bus Layanan antrean, artikel, dan langganan.

  • ID Konsumen: azureServiceBus
  • ID Tindakan: serviceBusQueueSend
  • Peristiwa yang didukung: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Pengaturan:
    • connectionString
      • string koneksi SAS
      • SAS (tanda tangan akses bersama) string koneksi digunakan untuk terhubung dengan Azure Bus Layanan. string koneksi ini tersedia di portal Azure.
      • Jenis data: string
      • Diperlukan: Ya
    • queueName
      • Nama antrean
      • Nama antrean untuk mengirim pesan. Nama hanya boleh berisi huruf, angka, titik, tanda hubung, garis miring, dan garis bawah. Nama harus dimulai dan diakhiri dengan huruf atau angka. Jika antrean tidak ada, antrean dibuat jika string koneksi yang ditentukan memiliki izin yang diperlukan.
      • Jenis data: string
      • Diperlukan: Ya
    • resourceDetailsToSend
      • Detail sumber daya yang akan dikirim
      • Mengontrol bidang sumber daya yang akan dikirim
      • Jenis data: string
      • Diperlukan: Tidak
    • messagesToSend
      • Pesan yang akan dikirim
      • Mengontrol pesan yang akan dikirim
      • Jenis data: string
      • Diperlukan: Tidak
    • detailedMessagesToSend
      • Pesan terperinci untuk dikirim
      • Mengontrol pesan terperinci untuk dikirim
      • Jenis data: string
      • Diperlukan: Tidak

Mengirim pesan ke Topik Bus Layanan

Tindakan ini mengirimkan representasi string JSON dari peristiwa ke topik Azure Bus Layanan yang ditentukan. Untuk informasi selengkapnya, lihat Menggunakan portal Azure untuk membuat topik Bus Layanan dan langganan topik tersebut.

  • ID Konsumen: azureServiceBus
  • ID Tindakan: serviceBusTopicSend
  • Peristiwa yang didukung: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Pengaturan:
    • connectionString
      • string koneksi SAS
      • SAS (tanda tangan akses bersama) string koneksi digunakan untuk terhubung dengan Azure Bus Layanan. string koneksi ini tersedia di portal Azure.
      • Jenis data: string
      • Diperlukan: Ya
    • topicName
      • Nama topik
      • Nama topik yang akan dikirimi pesan. Nama hanya boleh berisi huruf, angka, titik, tanda hubung, garis miring, dan garis bawah. Nama harus dimulai dan diakhiri dengan huruf atau angka. Jika topik tidak ada, topik akan dibuat jika string koneksi yang ditentukan memiliki izin yang diperlukan.
      • Jenis data: string
      • Diperlukan: Ya
    • resourceDetailsToSend
      • Detail sumber daya yang akan dikirim
      • Mengontrol bidang sumber daya yang akan dikirim
      • Jenis data: string
      • Diperlukan: Tidak
    • messagesToSend
      • Pesan yang akan dikirim
      • Mengontrol pesan yang akan dikirim
      • Jenis data: string
      • Diperlukan: Tidak
    • detailedMessagesToSend
      • Pesan terperinci untuk dikirim
      • Mengontrol pesan terperinci untuk dikirim
      • Jenis data: string
      • Diperlukan: Tidak

Azure Storage

Menyediakan integrasi dengan Microsoft Azure Storage.

Menyisipkan pesan dalam Antrean Penyimpanan

Tindakan ini menyisipkan representasi string JSON dari peristiwa ke antrean penyimpanan Azure yang ditentukan. Untuk informasi selengkapnya, lihat Apa itu antrean Azure?.

  • ID Konsumen: azureStorageQueue
  • ID Tindakan: antrean
  • Peristiwa yang didukung: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Pengaturan:
    • accountName
      • Nama akun penyimpanan
      • Nama yang terkait dengan akun penyimpanan Azure Anda (misalnya, https://STORAGE_ACCOUNT_NAME.queue.core.windows.net).
      • Jenis data: string
      • Diperlukan: Ya
    • accountKey
      • Kunci akun penyimpanan
      • Kunci yang terkait dengan akun penyimpanan Azure Anda.
      • Jenis data: string
      • Diperlukan: Ya
    • queueName
      • Nama antrean
      • Nama hanya huruf kecil dari antrean yang akan digunakan dalam penyimpanan Azure. Antrean dengan nama ini akan dibuat jika belum ada.
      • Jenis data: string
      • Diperlukan: Ya
    • visiTimeout
      • Batas waktu visibilitas pesan (dalam detik)
      • Menentukan nilai batas waktu visibilitas, dalam detik, untuk pesan antrean, relatif terhadap waktu server. Nilai harus lebih besar dari atau sama dengan 0, dan tidak boleh lebih besar dari tujuh hari, atau 604.800 detik. Batas waktu visibilitas harus diatur ke nilai yang lebih kecil dari nilai time-to-live pesan.
      • Jenis data: angka
      • Diperlukan: Ya
    • ttl
      • Waktu hidup pesan (dalam detik)
      • Menentukan interval waktu hidup untuk pesan antrean, dalam hitungan detik. Waktu hidup maksimum yang diizinkan adalah tujuh hari, atau 604.800 detik.
      • Jenis data: angka
      • Diperlukan: Ya
    • resourceDetailsToSend
      • Detail sumber daya yang akan dikirim
      • Mengontrol bidang sumber daya yang akan dikirim
      • Jenis data: string
      • Diperlukan: Tidak
    • messagesToSend
      • Pesan yang akan dikirim
      • Mengontrol pesan yang akan dikirim
      • Jenis data: string
      • Diperlukan: Tidak
    • detailedMessagesToSend
      • Pesan terperinci untuk dikirim
      • Mengontrol pesan terperinci untuk dikirim
      • Jenis data: string
      • Diperlukan: Tidak

Jenkins

Jenkins adalah server integrasi berkelanjutan, yang memungkinkan pembangunan dan pengujian proyek perangkat lunak terus menerus.

Memicu build Git

Memicu build yang dikonfigurasi untuk menggunakan repositori Git menggunakan Jenkins Git Plugin.

  • ID Konsumen: jenkins
  • ID Tindakan: triggerGitBuild
  • Peristiwa yang didukung: git.push
  • Pengaturan:
    • serverBaseUrl
      • URL dasar Jenkins
      • URL dasar yang menghosting server Jenkins
      • Jenis data: uri
      • Diperlukan: Ya
    • username
      • Nama pengguna
      • Nama pengguna Jenkins dari pengguna yang diizinkan untuk memicu build
      • Jenis data: string
      • Diperlukan: Ya
    • kata sandi
      • Token API pengguna (atau kata sandi)
      • Token API pengguna, yang tersedia di halaman konfigurasi pengguna Jenkins. Token API baru sejak versi 1.426. Untuk versi Jenkins yang lebih lama, kata sandi pengguna nyata harus ditentukan.
      • Jenis data: string
      • Diperlukan: Ya

Memicu build generik

Memicu build Jenkins generik, memanggil URL build Jenkins.

  • ID Konsumen: jenkins
  • ID Tindakan: triggerGenericBuild
  • Peristiwa yang didukung: git.push, build.complete, tfvc.checkin
  • Pengaturan:
    • serverBaseUrl
      • URL dasar Jenkins
      • URL dasar yang menghosting server Jenkins
      • Jenis data: uri
      • Diperlukan: Ya
    • username
      • Nama pengguna
      • Nama pengguna Jenkins dari pengguna yang diizinkan untuk memicu build
      • Jenis data: string
      • Diperlukan: Ya
    • kata sandi
      • Token API pengguna (atau kata sandi)
      • Token API pengguna, yang tersedia di halaman konfigurasi pengguna Jenkins. Token API baru sejak versi 1.426. Untuk versi Jenkins yang lebih lama, kata sandi pengguna nyata harus ditentukan.
      • Jenis data: string
      • Diperlukan: Ya
    • buildName
      • Build
      • Nama build yang akan dipicu
      • Jenis data: string
      • Diperlukan: Ya
    • buildAuthToken
      • Token build
      • Token otorisasi dalam bentuk string sehingga hanya pengguna yang tahu akan dapat memicu build proyek ini dari jarak jauh
      • Jenis data: string
      • Diperlukan: Tidak
    • buildParameterized
      • Menerima parameter
      • Menunjukkan apakah build diparameterkan atau tidak (parameter build ditentukan sebelumnya secara opsional)
      • Jenis data: boolean
      • Diperlukan: Tidak
    • buildParams
      • Parameter build
      • Nama dan nilai parameter build yang dipisahkan oleh titik dua(misalnya "param1:value1") dengan setiap pasangan nilai nama muncul pada baris teksnya sendiri
      • Jenis data: string
      • Diperlukan: Tidak

Trello

Menyediakan integrasi dengan Trello.

Membuat kartu

Tindakan ini membuat kartu pada daftar yang ada di Trello. Kartu dapat mewakili tugas, masalah, peristiwa, atau apa saja. Status kartu biasanya ditentukan oleh daftar tempat kartu berada. Untuk informasi selengkapnya, lihat Membuat hook layanan dengan Trello.

  • ID Konsumen: trello
  • ID Tindakan: createCard
  • Peristiwa yang didukung: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Pengaturan:
    • userToken
      • Token pengguna (Perlu satu? Dapatkan sekarang.)
      • Token pengguna Anda disediakan oleh Trello. Untuk mempelajari cara mendapatkan token ini, pilih tautan dalam deskripsi tindakan yang dijelaskan sebelumnya.
      • Jenis data: string
      • Diperlukan: Ya
    • boardId
      • Tercetak
      • Nama papan tempat kartu Trello dibuat.
      • Jenis data: string
      • Diperlukan: Ya
    • listId
      • List
      • Nama daftar tempat kartu Trello dibuat.
      • Jenis data: string
      • Diperlukan: Ya
    • label
      • Label
      • Daftar warna label yang dipisahkan koma untuk diterapkan ke kartu yang dibuat. Nama warna label yang valid adalah merah, oranye, kuning, hijau, biru, dan ungu.
      • Jenis data: string
      • Diperlukan: Tidak
    • addToTop
      • Buat di awal daftar
      • Menunjukkan apakah kartu harus dibuat di awal daftar Trello, bukan di akhir.
      • Jenis data: boolean
      • Diperlukan: Tidak

Buat daftar

Tindakan ini membuat daftar pada papan yang ada di Trello. Daftar digunakan untuk mengatur kartu di papan dan biasanya mewakili status. Untuk informasi selengkapnya, lihat Membuat hook layanan dengan Trello.

  • ID Konsumen: trello
  • ID Tindakan: createList
  • Peristiwa yang didukung: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Pengaturan:
    • userToken
      • Token pengguna (memerlukannya? Dapatkan sekarang.)
      • Token pengguna Anda disediakan oleh Trello. Untuk mempelajari cara mendapatkan token ini, pilih tautan dalam deskripsi tindakan yang dijelaskan sebelumnya.
      • Jenis data: string
      • Diperlukan: Ya
    • boardId
      • Tercetak
      • Nama papan tempat daftar Trello dibuat.
      • Jenis data: string
      • Diperlukan: Ya
    • addToBottom
      • Buat di bagian bawah papan
      • Menunjukkan apakah daftar harus dibuat di bagian bawah papan, bukan di bagian atas.
      • Jenis data: boolean
      • Diperlukan: Tidak

Webhook

Webhook menyediakan komunikasi peristiwa melalui HTTP.

Posting melalui HTTP

Tindakan ini memposting representasi objek JSON dari peristiwa ke URL yang ditentukan. Titik akhir HTTPS direkomendasikan karena potensi data privat dalam payload peristiwa. Untuk informasi selengkapnya, lihat Webhook.

  • ID Konsumen: webHooks
  • ID Tindakan: httpRequest
  • Peristiwa yang didukung: build.complete, git.push, tfvc.checkin, workitem.created, workitem.commented, workitem.updated
  • Pengaturan:
    • url
      • URL
      • URL tempat HTTP POST dikirim.
      • Jenis data: uri
      • Diperlukan: Ya
    • httpHeaders
      • Header HTTP
      • Kunci header HTTP dan nilai yang dipisahkan oleh titik dua(misalnya "Key1:value1") dengan setiap pasangan kunci-nilai muncul pada baris teksnya sendiri.
      • Jenis data: string
      • Diperlukan: Tidak
    • basicAuthUsername
      • Nama pengguna autentikasi dasar
      • Masukkan nama pengguna untuk autentikasi HTTP standar. Autentikasi HTTP dasar mengirimkan kredensial dalam teks biasa (tidak terenkripsi) yang berarti Anda harus menggunakan URL yang dimulai dengan "https" untuk mengaktifkan enkripsi kredensial ini melalui lapisan transportasi aman (SSL).
      • Jenis data: string
      • Diperlukan: Tidak
    • basicAuthPassword
      • Kata sandi autentikasi dasar
      • Masukkan kata sandi untuk autentikasi HTTP standar. Autentikasi HTTP dasar mengirimkan kredensial dalam teks biasa (tidak terenkripsi) yang berarti Anda harus menggunakan URL yang dimulai dengan "https" untuk mengaktifkan enkripsi kredensial ini melalui SSL.
      • Jenis data: string
      • Diperlukan: Tidak
    • resourceDetailsToSend
      • Detail sumber daya yang akan dikirim
      • Mengontrol bidang sumber daya yang akan dikirim
      • Jenis data: string
      • Diperlukan: Tidak
    • messagesToSend
      • Pesan yang akan dikirim
      • Mengontrol pesan yang akan dikirim
      • Jenis data: string
      • Diperlukan: Tidak
    • detailedMessagesToSend
      • Pesan terperinci untuk dikirim
      • Mengontrol pesan terperinci untuk dikirim
      • Jenis data: string
      • Diperlukan: Tidak

Zendesk

Zendesk adalah suite SaaS yang menawarkan tiket staf dukungan, pelacakan masalah, dan dukungan layanan pelanggan.

Membuat komentar privat dalam tiket

Gunakan Zendesk untuk membuat komentar pribadi dalam tiket.

  • ID Konsumen: zendesk
  • ID Tindakan: createPrivateComment
  • Peristiwa yang didukung: workitem.commented
  • Pengaturan:
    • accountName
      • Nama akun
      • Nama akun Zendesk seperti https://{account name}.zendesk.com
      • Jenis data: string
      • Diperlukan: Ya
    • username
      • Nama pengguna
      • Nama pengguna Zendesk pengguna yang memperbarui tiket
      • Jenis data: string
      • Diperlukan: Ya
    • apiToken
      • Token API
      • Token Zendesk API (dapat ditemukan di aplikasi Zendesk di Admin > Channels > API)
      • Jenis data: string
      • Diperlukan: Ya