Subscriptions - Create Subscriptions Query
Rechercher des abonnements de hook de service.
POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
|
api-version
|
query | True |
string |
Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| consumerActionId |
string |
ID d’action consommateur facultatif pour limiter les résultats à (null pour n’importe quel) |
| consumerId |
string |
ID consommateur facultatif pour limiter les résultats à (null pour n’importe quel) |
| consumerInputFilters |
Filtrer les entrées du consommateur d’abonnement |
|
| eventType |
string |
ID de type d’événement facultatif pour limiter les résultats à (null pour n’importe quel) |
| publisherId |
string |
ID d’éditeur facultatif pour limiter les résultats à (null pour n’importe quel) |
| publisherInputFilters |
Filtrer les entrées de l’éditeur d’abonnement |
|
| results |
Résultats de la requête |
|
| subscriberId |
string (uuid) |
Filtre d’abonné facultatif. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
opération réussie |
Sécurité
oauth2
Type:
oauth2
Flux:
accessCode
URL d’autorisation:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton:
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
Étendues
| Nom | Description |
|---|---|
| vso.work | Octroie la possibilité de lire des éléments de travail, des requêtes, des tableaux, des zones et des itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service. |
| vso.build | Accorde la possibilité d’accéder aux artefacts de build, notamment les résultats de build, les définitions et les demandes, et la possibilité de recevoir des notifications sur les événements de génération via des hooks de service. |
| vso.code | Accorde la possibilité de lire le code source et les métadonnées sur les validations, les ensembles de modifications, les branches et d’autres artefacts de contrôle de version. Accorde également la possibilité de rechercher du code et d’être averti des événements de contrôle de version via des hooks de service. |
Définitions
| Nom | Description |
|---|---|
|
Identity |
|
|
Input |
Définit un filtre pour les entrées d’abonnement. Le filtre correspond à un ensemble d’entrées si un (ou plusieurs) des groupes a la valeur true. |
|
Input |
Expression qui peut être appliquée pour filtrer une liste d’entrées d’abonnement |
|
Input |
Opérateur appliqué entre la valeur d’entrée attendue et réelle |
|
Reference |
Classe à représenter une collection de liens de référence REST. |
| Subscription |
Encapsule un abonnement aux événements. |
|
Subscriptions |
Définit une requête pour les abonnements de hook de service. |
|
Subscription |
IdentityRef
| Nom | Type | Description |
|---|---|---|
| _links |
Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique. |
|
| descriptor |
string |
Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique sur les comptes et les organisations. |
| directoryAlias |
string |
Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links » |
| displayName |
string |
Il s’agit du nom complet non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source. |
| id |
string |
|
| imageUrl |
string |
Déconseillé - Disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links » |
| inactive |
boolean |
Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links » |
| isAadIdentity |
boolean |
Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef |
| uniqueName |
string |
Déconseillé : utiliser Domain+PrincipalName à la place |
| url |
string |
Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe. |
InputFilter
Définit un filtre pour les entrées d’abonnement. Le filtre correspond à un ensemble d’entrées si un (ou plusieurs) des groupes a la valeur true.
| Nom | Type | Description |
|---|---|---|
| conditions |
Groupes d’expressions de filtre d’entrée. Ce filtre correspond à un ensemble d’entrées si un (ou plusieurs) des groupes a la valeur true. |
InputFilterCondition
Expression qui peut être appliquée pour filtrer une liste d’entrées d’abonnement
| Nom | Type | Description |
|---|---|---|
| caseSensitive |
boolean |
Indique si une correspondance respectant la casse ou non |
| inputId |
string |
ID de l’entrée à filtrer sur |
| inputValue |
string |
Valeur d’entrée « attendue » à comparer à la valeur d’entrée réelle |
| operator |
Opérateur appliqué entre la valeur d’entrée attendue et réelle |
InputFilterOperator
Opérateur appliqué entre la valeur d’entrée attendue et réelle
| Valeur | Description |
|---|---|
| equals | |
| notEquals |
ReferenceLinks
Classe à représenter une collection de liens de référence REST.
| Nom | Type | Description |
|---|---|---|
| links |
object |
Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule. |
Subscription
Encapsule un abonnement aux événements.
| Nom | Type | Description |
|---|---|---|
| _links |
Liens de référence |
|
| actionDescription |
string |
|
| consumerActionId |
string |
|
| consumerId |
string |
|
| consumerInputs |
object |
Valeurs d’entrée du consommateur |
| createdBy | ||
| createdDate |
string (date-time) |
|
| eventDescription |
string |
|
| eventType |
string |
|
| id |
string (uuid) |
|
| lastProbationRetryDate |
string (date-time) |
|
| modifiedBy | ||
| modifiedDate |
string (date-time) |
|
| probationRetries |
string (byte) |
|
| publisherId |
string |
|
| publisherInputs |
object |
Valeurs d’entrée du serveur de publication |
| resourceVersion |
string |
|
| status | ||
| subscriber | ||
| url |
string |
SubscriptionsQuery
Définit une requête pour les abonnements de hook de service.
| Nom | Type | Description |
|---|---|---|
| consumerActionId |
string |
ID d’action consommateur facultatif pour limiter les résultats à (null pour n’importe quel) |
| consumerId |
string |
ID consommateur facultatif pour limiter les résultats à (null pour n’importe quel) |
| consumerInputFilters |
Filtrer les entrées du consommateur d’abonnement |
|
| eventType |
string |
ID de type d’événement facultatif pour limiter les résultats à (null pour n’importe quel) |
| publisherId |
string |
ID d’éditeur facultatif pour limiter les résultats à (null pour n’importe quel) |
| publisherInputFilters |
Filtrer les entrées de l’éditeur d’abonnement |
|
| results |
Résultats de la requête |
|
| subscriberId |
string (uuid) |
Filtre d’abonné facultatif. |
SubscriptionStatus
| Valeur | Description |
|---|---|
| disabledByInactiveIdentity |
L’abonnement est désactivé, car le propriétaire est inactif ou a des autorisations manquantes. |
| disabledBySystem |
L’abonnement est désactivé par le système. |
| disabledByUser |
L’abonnement est désactivé par un utilisateur. |
| enabled |
L’abonnement est activé. |
| onProbation |
L’abonnement est temporairement mis en probation par le système. |