NotificationSubscription interface

Paquet:

azure-devops-extension-api

Un abonnement définit les critères de correspondance des événements et la façon dont l’abonné de l’abonnement doit être informé de ces événements.

Propriétés

adminSettings	Administration paramètres gérés pour l’abonnement. S’applique uniquement lorsque l’abonné est un groupe.
channel	Canal de remise des notifications déclenchées par l’abonnement.
description	Description de l’abonnement. Décrit généralement les critères de filtre qui aident à identifier l’abonnement.
diagnostics	Diagnostics pour cet abonnement.
extendedProperties	Toutes les propriétés supplémentaires telles que la description détaillée pour différents contextes, contextes utilisateur/groupe
filter	Critères correspondants pour l’abonnement. ExpressionFilter
flags	Indicateurs en lecture seule qui décrivent davantage l’abonnement.
id	Identificateur d'abonnement.
lastModifiedBy	Utilisateur qui a modifié (ou créé) l’abonnement pour la dernière fois.
modifiedDate	Date de la dernière modification de l’abonnement. Si l’abonnement n’a pas été mis à jour depuis sa création, cette valeur indique quand l’abonnement a été créé.
permissions	Autorisations dont dispose l’utilisateur pour ces abonnements.
scope	Conteneur dans lequel les événements doivent être publiés pour être mis en correspondance par l’abonnement. Si elle est vide, l’étendue est l’hôte actuel (généralement un compte ou une collection de projets). Par exemple, un abonnement limité au projet A ne génère pas de notifications pour les événements publiés à partir du projet B.
status	État de l’abonnement. Indique généralement si l’abonnement est activé ou non.
statusMessage	Message qui fournit plus de détails sur la status de l’abonnement.
subscriber	Utilisateur ou groupe qui recevra des notifications pour les événements correspondant aux critères de filtre de l’abonnement.
url	URL de l’API REST de l’abonnement.
userSettings	Paramètres gérés par l’utilisateur pour l’abonnement. S’applique uniquement lorsque l’abonné est un groupe. Généralement utilisé pour indiquer si l’utilisateur appelant est inscrit ou exclu d’un abonnement de groupe.

Détails de la propriété

adminSettings

Administration paramètres gérés pour l’abonnement. S’applique uniquement lorsque l’abonné est un groupe.

adminSettings: SubscriptionAdminSettings

Valeur de propriété

SubscriptionAdminSettings

channel

Canal de remise des notifications déclenchées par l’abonnement.

channel: ISubscriptionChannel

Valeur de propriété

ISubscriptionChannel

description

Description de l’abonnement. Décrit généralement les critères de filtre qui aident à identifier l’abonnement.

description: string

Valeur de propriété

string

diagnostics

Diagnostics pour cet abonnement.

diagnostics: SubscriptionDiagnostics

Valeur de propriété

SubscriptionDiagnostics

extendedProperties

Toutes les propriétés supplémentaires telles que la description détaillée pour différents contextes, contextes utilisateur/groupe

extendedProperties: {[key: string]: string}

Valeur de propriété

{[key: string]: string}

filter

Critères correspondants pour l’abonnement. ExpressionFilter

filter: ISubscriptionFilter

Valeur de propriété

ISubscriptionFilter

flags

Indicateurs en lecture seule qui décrivent davantage l’abonnement.

flags: SubscriptionFlags

Valeur de propriété

SubscriptionFlags

id

Identificateur d'abonnement.

id: string

Valeur de propriété

string

lastModifiedBy

Utilisateur qui a modifié (ou créé) l’abonnement pour la dernière fois.

lastModifiedBy: IdentityRef

Valeur de propriété

IdentityRef

modifiedDate

Date de la dernière modification de l’abonnement. Si l’abonnement n’a pas été mis à jour depuis sa création, cette valeur indique quand l’abonnement a été créé.

modifiedDate: Date

Valeur de propriété

Date

permissions

Autorisations dont dispose l’utilisateur pour ces abonnements.

permissions: SubscriptionPermissions

Valeur de propriété

SubscriptionPermissions

scope

Conteneur dans lequel les événements doivent être publiés pour être mis en correspondance par l’abonnement. Si elle est vide, l’étendue est l’hôte actuel (généralement un compte ou une collection de projets). Par exemple, un abonnement limité au projet A ne génère pas de notifications pour les événements publiés à partir du projet B.

scope: SubscriptionScope

Valeur de propriété

SubscriptionScope

status

État de l’abonnement. Indique généralement si l’abonnement est activé ou non.

status: SubscriptionStatus

Valeur de propriété

SubscriptionStatus

statusMessage

Message qui fournit plus de détails sur la status de l’abonnement.

statusMessage: string

Valeur de propriété

string

subscriber

Utilisateur ou groupe qui recevra des notifications pour les événements correspondant aux critères de filtre de l’abonnement.

subscriber: IdentityRef

Valeur de propriété

IdentityRef

url

URL de l’API REST de l’abonnement.

url: string

Valeur de propriété

string

userSettings

Paramètres gérés par l’utilisateur pour l’abonnement. S’applique uniquement lorsque l’abonné est un groupe. Généralement utilisé pour indiquer si l’utilisateur appelant est inscrit ou exclu d’un abonnement de groupe.

userSettings: SubscriptionUserSettings

Valeur de propriété

SubscriptionUserSettings