Freigeben über

Subscriptions - Create Subscriptions Query

  • Referenz
Dienst:
Service Hooks
API-Version:
7.1

Abfrage für Diensthakenabonnements.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
 path True

string

Der Name der Azure DevOps-Organisation.
api-version
 query True

string

Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name Typ Beschreibung
consumerActionId

string

Optionale Consumeraktions-ID, um die Ergebnisse einzuschränken (null für beliebige)
consumerId

string

Optionale Consumer-ID, um die Ergebnisse einzuschränken (null für beliebige)
consumerInputFilters

InputFilter[]

Filtern nach Abonnement-Verbrauchereingaben
eventType

string

Optionale Ereignistyp-ID, um die Ergebnisse einzuschränken (null für beliebige)
publisherId

string

Optionale Herausgeber-ID, um die Ergebnisse einzuschränken (null für beliebige)
publisherInputFilters

InputFilter[]

Filtern nach Abonnementherausgebereingaben
results

Subscription[]

Ergebnisse aus der Abfrage
subscriberId

string (uuid)

Optionaler Abonnentenfilter.

Antworten

Name Typ Beschreibung
200 OK

SubscriptionsQuery

Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name Beschreibung
vso.work Gewährt die Möglichkeit, Arbeitsaufgaben, Abfragen, Boards, Flächen- und Iterationspfade und andere Metadaten zur Nachverfolgung von Arbeitsaufgaben zu lesen. Gewährt außerdem die Möglichkeit, Abfragen auszuführen, Arbeitsaufgaben zu durchsuchen und Benachrichtigungen über Arbeitsaufgabenereignisse über Dienst-Hooks zu erhalten.
vso.build Gewährt die Möglichkeit, auf Buildartefakte zuzugreifen, einschließlich Buildergebnissen, Definitionen und Anforderungen sowie die Möglichkeit, Benachrichtigungen über Buildereignisse über Dienst-Hooks zu empfangen.
vso.code Gewährt die Möglichkeit, Quellcode und Metadaten zu Commits, Changesets, Verzweigungen und anderen Versionskontrollartefakten zu lesen. Gewährt außerdem die Möglichkeit, Code zu durchsuchen und über Dienst-Hooks über Versionssteuerungsereignisse benachrichtigt zu werden.

Definitionen

Name Beschreibung
IdentityRef
InputFilter

Definiert einen Filter für Abonnementeingaben. Der Filter entspricht einer Reihe von Eingaben, wenn eine der Gruppen (eine oder mehrere) als "true" ausgewertet wird.
InputFilterCondition

Ein Ausdruck, der angewendet werden kann, um eine Liste von Abonnementeingaben zu filtern
InputFilterOperator

Der Operator, der zwischen dem erwarteten und dem tatsächlichen Eingabewert angewendet wird
ReferenceLinks

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
Subscription

Kapselt ein Ereignisabonnement.
SubscriptionsQuery

Definiert eine Abfrage für Diensthakenabonnements.
SubscriptionStatus

IdentityRef

Objekt
Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor

string

Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias

string

Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName

string

Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id

string

imageUrl

string

Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive

boolean

Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity

boolean

Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName

string

Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

InputFilter

Objekt

Definiert einen Filter für Abonnementeingaben. Der Filter entspricht einer Reihe von Eingaben, wenn eine der Gruppen (eine oder mehrere) als "true" ausgewertet wird.

Name Typ Beschreibung
conditions

InputFilterCondition[]

Gruppen von Eingabefilterausdrücken. Dieser Filter entspricht einer Reihe von Eingaben, wenn eine der Gruppen (eine oder mehrere) zu "true" ausgewertet wird.

InputFilterCondition

Objekt

Ein Ausdruck, der angewendet werden kann, um eine Liste von Abonnementeingaben zu filtern

Name Typ Beschreibung
caseSensitive

boolean

Gibt an, ob bei einer Übereinstimmung zwischen Groß- und Kleinschreibung unterschieden werden soll.
inputId

string

Die ID der zu filternden Eingabe
inputValue

string

Der "erwartete" Eingabewert, der mit dem tatsächlichen Eingabewert verglichen werden soll
operator

InputFilterOperator

Der Operator, der zwischen dem erwarteten und dem tatsächlichen Eingabewert angewendet wird

InputFilterOperator

Enumeration

Der Operator, der zwischen dem erwarteten und dem tatsächlichen Eingabewert angewendet wird

Wert Beschreibung
equals
notEquals
Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

Subscription

Objekt

Kapselt ein Ereignisabonnement.

Name Typ Beschreibung
_links

ReferenceLinks

Referenzlinks
actionDescription

string

consumerActionId

string

consumerId

string

consumerInputs

object

Eingabewerte für Verbraucher
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

Publisher-Eingabewerte
resourceVersion

string

status

SubscriptionStatus

subscriber

IdentityRef

url

string

SubscriptionsQuery

Objekt

Definiert eine Abfrage für Diensthakenabonnements.

Name Typ Beschreibung
consumerActionId

string

Optionale Consumeraktions-ID, um die Ergebnisse einzuschränken (null für beliebige)
consumerId

string

Optionale Consumer-ID, um die Ergebnisse einzuschränken (null für beliebige)
consumerInputFilters

InputFilter[]

Filtern nach Abonnement-Verbrauchereingaben
eventType

string

Optionale Ereignistyp-ID, um die Ergebnisse einzuschränken (null für beliebige)
publisherId

string

Optionale Herausgeber-ID, um die Ergebnisse einzuschränken (null für beliebige)
publisherInputFilters

InputFilter[]

Filtern nach Abonnementherausgebereingaben
results

Subscription[]

Ergebnisse aus der Abfrage
subscriberId

string (uuid)

Optionaler Abonnentenfilter.

SubscriptionStatus

Enumeration
Wert Beschreibung
disabledByInactiveIdentity

Das Abonnement ist deaktiviert, da der Besitzer inaktiv ist oder keine Berechtigungen besitzt.
disabledBySystem

Das Abonnement wird vom System deaktiviert.
disabledByUser

Das Abonnement wird von einem Benutzer deaktiviert.
enabled

Das Abonnement ist aktiviert.
onProbation

Das Abonnement wird vorübergehend vom System zur Bewährung ausgeführt.