Subscriptions - Create

Layanan:: Service Hooks

Versi API:: 7.1

Buat langganan.

POST https://dev.azure.com/{organization}/_apis/hooks/subscriptions?api-version=7.1

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Tautan Referensi
actionDescription	string
consumerActionId	string
consumerId	string
consumerInputs	object	Nilai input konsumen
createdBy	IdentityRef
createdDate	string (date-time)
eventDescription	string
eventType	string
id	string (uuid)
lastProbationRetryDate	string (date-time)
modifiedBy	IdentityRef
modifiedDate	string (date-time)
probationRetries	string (byte)
publisherId	string
publisherInputs	object	Nilai input penerbit
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

Respons

Nama	Jenis	Deskripsi
200 OK	Subscription	operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Cakupan

Nama	Deskripsi
vso.work	Memberikan kemampuan untuk membaca item kerja, kueri, papan, jalur area dan iterasi, dan metadata terkait pelacakan item kerja lainnya. Juga memberikan kemampuan untuk menjalankan kueri, mencari item kerja, dan menerima pemberitahuan tentang peristiwa item kerja melalui kait layanan.
vso.build	Memberikan kemampuan untuk mengakses artefak build, termasuk hasil build, definisi, dan permintaan, dan kemampuan untuk menerima pemberitahuan tentang peristiwa build melalui kait layanan.
vso.code	Memberikan kemampuan untuk membaca kode sumber dan metadata tentang penerapan, set perubahan, cabang, dan artefak kontrol versi lainnya. Juga memberikan kemampuan untuk mencari kode dan mendapatkan pemberitahuan tentang peristiwa kontrol versi melalui kait layanan.

Contoh

Permintaan sampel

HTTP

POST https://dev.azure.com/fabrikam/_apis/hooks/subscriptions?api-version=7.1

{
  "publisherId": "tfs",
  "eventType": "build.complete",
  "resourceVersion": "1.0-preview.1",
  "consumerId": "webHooks",
  "consumerActionId": "httpRequest",
  "publisherInputs": {
    "buildStatus": "Failed",
    "definitionName": "MyWebSite CI",
    "projectId": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c"
  },
  "consumerInputs": {
    "url": "https://myservice/newreceiver"
  }
}

Respon sampel

Kode status:: 200

{
  "id": "fd672255-8b6b-4769-9260-beea83d752ce",
  "url": "https://dev.azure.com/fabrikam/_apis/hooks/subscriptions/fd672255-8b6b-4769-9260-beea83d752ce",
  "publisherId": "tfs",
  "eventType": "build.complete",
  "resourceVersion": "1.0-preview.1",
  "eventDescription": "Build MyWebSite CI, status Failed",
  "consumerId": "webHooks",
  "consumerActionId": "httpRequest",
  "actionDescription": "To host myservice",
  "createdBy": {
    "id": "00ca946b-2fe9-4f2a-ae2f-40d5c48001bc"
  },
  "createdDate": "2014-10-27T15:37:24.873Z",
  "modifiedBy": {
    "id": "00ca946b-2fe9-4f2a-ae2f-40d5c48001bc"
  },
  "modifiedDate": "2014-10-27T15:37:26.23Z",
  "publisherInputs": {
    "buildStatus": "Failed",
    "definitionName": "MyWebSite CI",
    "hostId": "d81542e4-cdfa-4333-b082-1ae2d6c3ad16",
    "projectId": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "tfsSubscriptionId": "3e8b33e7-426d-4c92-9bf9-58e163dd7dd5"
  },
  "consumerInputs": {
    "url": "https://myservice/newreceiver"
  }
}

Definisi

Nama	Deskripsi
IdentityRef
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
Subscription	Merangkum langganan peristiwa.
SubscriptionStatus

IdentityRef

Objek

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi yang lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem sedang berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.
directoryAlias	string	Tidak digunakan lagi - Dapat diambil dengan mengkueri pengguna Graph yang direferensikan dalam entri "diri" kamus IdentityRef "_links"
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
id	string
imageUrl	string	Tidak digunakan lagi - Tersedia dalam entri "avatar" kamus IdentityRef "_links"
inactive	boolean	Tidak digunakan lagi - Dapat diambil dengan mengkueri status keanggotaan Graph yang direferensikan dalam entri "membershipState" kamus "_links" GraphUser
isAadIdentity	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Tidak digunakan lagi - tidak digunakan dalam sebagian besar implementasi ToIdentityRef yang sudah ada sebelumnya
uniqueName	string	Tidak digunakan lagi - gunakan Domain+PrincipalName sebagai gantinya
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

ReferenceLinks

Objek

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan tautan secara baca-saja. Karena tautan Referensi dibaca saja, kami hanya ingin mengeksposnya sebagai baca-saja.

Subscription

Objek

Merangkum langganan peristiwa.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Tautan Referensi
actionDescription	string
consumerActionId	string
consumerId	string
consumerInputs	object	Nilai input konsumen
createdBy	IdentityRef
createdDate	string (date-time)
eventDescription	string
eventType	string
id	string (uuid)
lastProbationRetryDate	string (date-time)
modifiedBy	IdentityRef
modifiedDate	string (date-time)
probationRetries	string (byte)
publisherId	string
publisherInputs	object	Nilai input penerbit
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

SubscriptionStatus

Enumerasi

Nilai	Deskripsi
enabled	Langganan diaktifkan.
onProbation	Langganan sementara diselimuti oleh sistem.
disabledByUser	Langganan dinonaktifkan oleh pengguna.
disabledBySystem	Langganan dinonaktifkan oleh sistem.
disabledByInactiveIdentity	Langganan dinonaktifkan karena pemilik tidak aktif atau tidak memiliki izin.