Subscriptions - Create Subscriptions Query

Referensi

Service:: Service Hooks

API Version:: 7.1-preview.1

Kueri untuk langganan hook layanan.

POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1-preview.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-preview.1' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
consumerActionId	string	Id tindakan konsumen opsional untuk membatasi hasil ke (null untuk apa pun)
consumerId	string	Id konsumen opsional untuk membatasi hasil (null untuk apa pun)
consumerInputFilters	InputFilter[]	Filter untuk input konsumen langganan
eventType	string	Id jenis peristiwa opsional untuk membatasi hasil (null untuk apa pun)
publisherId	string	Id penerbit opsional untuk membatasi hasil (null untuk apa pun)
publisherInputFilters	InputFilter[]	Filter untuk input penerbit langganan
results	Subscription[]	Hasil dari kueri
subscriberId	string	Filter pelanggan opsional.

Respons

Nama	Jenis	Deskripsi
200 OK	SubscriptionsQuery	operasi berhasil

Keamanan

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: 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

Scopes

Nama	Deskripsi
vso.work	Memberikan kemampuan untuk membaca item kerja, kueri, papan, jalur perulangan dan area, serta 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 hook layanan.

Definisi

Nama	Deskripsi
IdentityRef
InputFilter	Menentukan filter untuk input langganan. Filter cocok dengan sekumpulan input jika ada (satu atau beberapa) grup yang dievaluasi ke true.
InputFilterCondition	Ekspresi yang dapat diterapkan untuk memfilter daftar input langganan
InputFilterOperator	Operator diterapkan antara nilai input yang diharapkan dan aktual
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
Subscription	Merangkum langganan peristiwa.
SubscriptionsQuery	Menentukan kueri untuk langganan hook layanan.
SubscriptionStatus

IdentityRef

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 lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem 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 "mandiri" 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.

InputFilter

Menentukan filter untuk input langganan. Filter cocok dengan sekumpulan input jika ada (satu atau beberapa) grup yang dievaluasi ke true.

Nama	Jenis	Deskripsi
conditions	InputFilterCondition[]	Grup ekspresi filter input. Filter ini cocok dengan sekumpulan input jika ada (satu atau beberapa) grup yang dievaluasi ke true.

InputFilterCondition

Ekspresi yang dapat diterapkan untuk memfilter daftar input langganan

Nama	Jenis	Deskripsi
caseSensitive	boolean	Apakah akan melakukan kecocokan peka huruf besar/kecil atau tidak
inputId	string	Id input yang akan difilter
inputValue	string	Nilai input "diharapkan" untuk dibandingkan dengan nilai input aktual
operator	InputFilterOperator	Operator diterapkan antara nilai input yang diharapkan dan aktual

InputFilterOperator

Operator diterapkan antara nilai input yang diharapkan dan aktual

Nama	Jenis	Deskripsi
equals	string
notEquals	string

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

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

Subscription

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
eventDescription	string
eventType	string
id	string
lastProbationRetryDate	string
modifiedBy	IdentityRef
modifiedDate	string
probationRetries	string
publisherId	string
publisherInputs	object	Nilai input penerbit
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

SubscriptionsQuery

Menentukan kueri untuk langganan hook layanan.

Nama	Jenis	Deskripsi
consumerActionId	string	Id tindakan konsumen opsional untuk membatasi hasil ke (null untuk apa pun)
consumerId	string	Id konsumen opsional untuk membatasi hasil (null untuk apa pun)
consumerInputFilters	InputFilter[]	Filter untuk input konsumen langganan
eventType	string	Id jenis peristiwa opsional untuk membatasi hasil (null untuk apa pun)
publisherId	string	Id penerbit opsional untuk membatasi hasil (null untuk apa pun)
publisherInputFilters	InputFilter[]	Filter untuk input penerbit langganan
results	Subscription[]	Hasil dari kueri
subscriberId	string	Filter pelanggan opsional.

SubscriptionStatus

Nama	Jenis	Deskripsi
disabledByInactiveIdentity	string	Langganan dinonaktifkan karena pemilik tidak aktif atau tidak memiliki izin.
disabledBySystem	string	Langganan dinonaktifkan oleh sistem.
disabledByUser	string	Langganan dinonaktifkan oleh pengguna.
enabled	string	Langganan diaktifkan.
onProbation	string	Langganan sementara dalam masa percobaan oleh sistem.

Bagikan melalui