Subscriptions - Create Subscriptions Query

Reference

Service:: Service Hooks

API Version:: 7.1-preview.1

Dotaz na předplatná pro připojení služby

POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?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
consumerActionId	string	Volitelné ID akce příjemce pro omezení výsledků na (hodnota null pro libovolnou)
consumerId	string	Volitelné ID příjemce pro omezení výsledků na hodnotu (null pro libovolné)
consumerInputFilters	InputFilter[]	Filtrování vstupů uživatelů předplatného
eventType	string	Id volitelného typu události pro omezení výsledků na hodnotu (null pro libovolnou)
publisherId	string	Volitelné ID vydavatele pro omezení výsledků na (null pro libovolné)
publisherInputFilters	InputFilter[]	Filtr pro vstupy vydavatele předplatného
results	Subscription[]	Výsledky z dotazu
subscriberId	string	Volitelný filtr odběratele.

Odpovědi

Name	Typ	Description
200 OK	SubscriptionsQuery	ú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.

Definice

Name	Description
IdentityRef
InputFilter	Definuje filtr pro vstupy předplatného. Filtr odpovídá sadě vstupů, pokud se některá (jedna nebo více) skupin vyhodnotí jako true.
InputFilterCondition	Výraz, který lze použít k filtrování seznamu vstupů předplatného
InputFilterOperator	Operátor použitý mezi očekávanou a skutečnou vstupní hodnotou
ReferenceLinks	Třída představující kolekci odkazů REST.
Subscription	Zapouzdří odběr události.
SubscriptionsQuery	Definuje dotaz pro předplatná pro připojení služby.
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.

InputFilter

Definuje filtr pro vstupy předplatného. Filtr odpovídá sadě vstupů, pokud se některá (jedna nebo více) skupin vyhodnotí jako true.

Name	Typ	Description
conditions	InputFilterCondition[]	Skupiny výrazů vstupního filtru Tento filtr odpovídá sadě vstupů, pokud se některá (jedna nebo více) skupin vyhodnotí jako true.

InputFilterCondition

Výraz, který lze použít k filtrování seznamu vstupů předplatného

Name	Typ	Description
caseSensitive	boolean	Zda se má rozlišovat velká a malá písmena
inputId	string	ID vstupu, podle který se má filtrovat
inputValue	string	"Očekávaná" vstupní hodnota pro porovnání se skutečnou vstupní hodnotou
operator	InputFilterOperator	Operátor použitý mezi očekávanou a skutečnou vstupní hodnotou

InputFilterOperator

Operátor použitý mezi očekávanou a skutečnou vstupní hodnotou

Name	Typ	Description
equals	string
notEquals	string

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

SubscriptionsQuery

Definuje dotaz pro předplatná pro připojení služby.

Name	Typ	Description
consumerActionId	string	Volitelné ID akce příjemce pro omezení výsledků na (hodnota null pro libovolnou)
consumerId	string	Volitelné ID příjemce pro omezení výsledků na hodnotu (null pro libovolné)
consumerInputFilters	InputFilter[]	Filtrování vstupů uživatelů předplatného
eventType	string	Id volitelného typu události pro omezení výsledků na hodnotu (null pro libovolnou)
publisherId	string	Volitelné ID vydavatele pro omezení výsledků na (null pro libovolné)
publisherInputFilters	InputFilter[]	Filtr pro vstupy vydavatele předplatného
results	Subscription[]	Výsledky z dotazu
subscriberId	string	Volitelný filtr odběratele.

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