Subscriptions - Create

Service:

Service Hooks

API Version:

7.1-preview.1

Bir abonelik oluşturun.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
_links	ReferenceLinks	Başvuru Bağlantıları
actionDescription	string
consumerActionId	string
consumerId	string
consumerInputs	object	Tüketici giriş değerleri
createdBy	IdentityRef
createdDate	string
eventDescription	string
eventType	string
id	string
lastProbationRetryDate	string
modifiedBy	IdentityRef
modifiedDate	string
probationRetries	string
publisherId	string
publisherInputs	object	Yayımcı giriş değerleri
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

Yanıtlar

Name	Tür	Description
200 OK	Subscription	başarılı işlem

Güvenlik

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

Name	Description
vso.work	İş öğelerini, sorguları, panoları, alan ve yineleme yollarını ve diğer iş öğesi izlemeyle ilgili meta verileri okuma olanağı verir. Ayrıca sorguları yürütme, iş öğelerini arama ve hizmet kancaları aracılığıyla iş öğesi olayları hakkında bildirim alma olanağı verir.
vso.build	Derleme sonuçları, tanımlar ve istekler dahil olmak üzere derleme yapıtlarına erişme ve hizmet kancaları aracılığıyla derleme olayları hakkında bildirim alma olanağı verir.
vso.code	İşlemeler, değişiklik kümeleri, dallar ve diğer sürüm denetimi yapıtları hakkında kaynak kodu ve meta verileri okuma yeteneği verir. Ayrıca kod arama ve hizmet kancaları aracılığıyla sürüm denetimi olayları hakkında bildirim alma olanağı verir.

Örnekler

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/hooks/subscriptions?api-version=7.1-preview.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"
  }
}

Sample Response

Status code:

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"
  }
}

Tanımlar

Name	Description
IdentityRef
ReferenceLinks	REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.
Subscription	Bir olay aboneliğini kapsüller.
SubscriptionStatus

IdentityRef

Name	Tür	Description
_links	ReferenceLinks	Bu alan, grafik konusuyla ilgili sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında ek ilişkiler veya daha ayrıntılı bilgi edinmek için çağrılabilir.
descriptor	string	Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar.
directoryAlias	string	Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir
displayName	string	Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir.
id	string
imageUrl	string	Kullanım dışı - IdentityRef "_links" sözlüğündeki "avatar" girişinde kullanılabilir
inactive	boolean	Kullanım dışı - GraphUser "_links" sözlüğündeki "membershipState" girdisinde başvurulan Graph üyelik durumu sorgulanarak alınabilir
isAadIdentity	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil
uniqueName	string	Kullanım dışı - bunun yerine Domain+PrincipalName kullanın
url	string	Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur.

ReferenceLinks

REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak kullanıma açmak istiyoruz.

Subscription

Bir olay aboneliğini kapsüller.

Name	Tür	Description
_links	ReferenceLinks	Başvuru Bağlantıları
actionDescription	string
consumerActionId	string
consumerId	string
consumerInputs	object	Tüketici giriş değerleri
createdBy	IdentityRef
createdDate	string
eventDescription	string
eventType	string
id	string
lastProbationRetryDate	string
modifiedBy	IdentityRef
modifiedDate	string
probationRetries	string
publisherId	string
publisherInputs	object	Yayımcı giriş değerleri
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

SubscriptionStatus

Name	Tür	Description
disabledByInactiveIdentity	string	Sahip etkin olmadığından veya izinleri eksik olduğundan abonelik devre dışı bırakıldı.
disabledBySystem	string	Abonelik sistem tarafından devre dışı bırakıldı.
disabledByUser	string	Abonelik bir kullanıcı tarafından devre dışı bırakıldı.
enabled	string	Abonelik etkinleştirildi.
onProbation	string	Abonelik, sistem tarafından geçici olarak gözetim altındadır.