Subscriptions - Create

Reference

Service:: Service Hooks

API Version:: 7.1-preview.1

Vytvořte předplatné.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.

Text požadavku

Name	Typ	Description
_links	ReferenceLinks	Odkazy
actionDescription	string
consumerActionId	string
consumerId	string
consumerInputs	object	Vstupní hodnoty příjemce
createdBy	IdentityRef
createdDate	string
eventDescription	string
eventType	string
id	string
lastProbationRetryDate	string
modifiedBy	IdentityRef
modifiedDate	string
probationRetries	string
publisherId	string
publisherInputs	object	Vstupní hodnoty publisheru
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

Odpovědi

Name	Typ	Description
200 OK	Subscription	úspěšná operace

Zabezpečení

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	Umožňuje číst pracovní položky, dotazy, panely, cesty oblastí a iterací a další metadata související se sledováním pracovních položek. Umožňuje také spouštět dotazy, prohledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím služeb.
vso.build	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost přijímat oznámení o událostech sestavení prostřednictvím připojení služeb.
vso.code	Umožňuje číst zdrojový kód a metadata o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Umožňuje také prohledávat kód a dostávat oznámení o událostech správy verzí prostřednictvím služby Hooks.

Příklady

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

Definice

Name	Description
IdentityRef
ReferenceLinks	Třída představující kolekci odkazů REST.
Subscription	Zapouzdří odběr události.
SubscriptionStatus

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi.
directoryAlias	string	Zastaralé – lze načíst dotazem uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links".
inactive	boolean	Zastaralé – lze načíst dotazem na stav členství graphu, na který odkazuje položka membershipState slovníku GraphUser "_links".
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

Subscription

Zapouzdří odběr události.

Name	Typ	Description
_links	ReferenceLinks	Odkazy
actionDescription	string
consumerActionId	string
consumerId	string
consumerInputs	object	Vstupní hodnoty příjemce
createdBy	IdentityRef
createdDate	string
eventDescription	string
eventType	string
id	string
lastProbationRetryDate	string
modifiedBy	IdentityRef
modifiedDate	string
probationRetries	string
publisherId	string
publisherInputs	object	Vstupní hodnoty publisheru
resourceVersion	string
status	SubscriptionStatus
subscriber	IdentityRef
url	string

SubscriptionStatus

Name	Typ	Description
disabledByInactiveIdentity	string	Předplatné je zakázané, protože vlastník není aktivní nebo mu chybí oprávnění.
disabledBySystem	string	Systém předplatné zakáže.
disabledByUser	string	Předplatné je zakázané uživatelem.
enabled	string	Předplatné je povolené.
onProbation	string	Předplatné je dočasně ve zkušebním režimu ze strany systému.

Sdílet prostřednictvím