NotificationSubscriptionUpdateParameters interface

Paquet:

azure-devops-extension-api

Paramètres de mise à jour d’un abonnement existant. Un abonnement définit des critères pour les événements correspondants et la façon dont l’abonné de l’abonnement doit être informé de ces événements. Remarque : seuls les champs à mettre à jour doivent être définis.

Propriétés

adminSettings	Paramètres gérés par l’administrateur pour l’abonnement. S’applique uniquement aux abonnements dont l’abonné fait partie d’un groupe.
channel	Canal de diffusion des notifications déclenchées par l’abonnement.
description	Mise à jour de la description de l’abonnement. Décrit généralement les critères de filtrage qui permettent d’identifier l’abonnement.
filter	Critères de correspondance pour l’abonnement. ExpressionFilter
scope	Conteneur dans lequel les événements doivent être publiés pour être mis en correspondance avec le nouvel abonnement. S’il n’est pas spécifié, la valeur par défaut est l’hôte actuel (généralement le compte actuel ou la collection de projets). Par exemple, un abonnement limité au projet A ne produira pas de notifications pour les événements publiés à partir du projet B.
status	Mise à jour de l’état de l’abonnement. Généralement utilisé pour activer ou désactiver un abonnement.
statusMessage	Message facultatif qui fournit plus de détails sur l’état mis à jour.
userSettings	Paramètres gérés par l’utilisateur pour l’abonnement. S’applique uniquement aux abonnements dont l’abonné fait partie d’un groupe. Généralement utilisé pour activer ou désactiver un utilisateur d’un abonnement de groupe.

Détails de la propriété

adminSettings

Paramètres gérés par l’administrateur pour l’abonnement. S’applique uniquement aux abonnements dont l’abonné fait partie d’un groupe.

adminSettings: SubscriptionAdminSettings

Valeur de propriété

SubscriptionAdminSettings

channel

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

channel: ISubscriptionChannel

Valeur de propriété

ISubscriptionChannel

description

Mise à jour de la description de l’abonnement. Décrit généralement les critères de filtrage qui permettent d’identifier l’abonnement.

description: string

Valeur de propriété

string

filter

Critères de correspondance pour l’abonnement. ExpressionFilter

filter: ISubscriptionFilter

Valeur de propriété

ISubscriptionFilter

scope

Conteneur dans lequel les événements doivent être publiés pour être mis en correspondance avec le nouvel abonnement. S’il n’est pas spécifié, la valeur par défaut est l’hôte actuel (généralement le compte actuel ou la collection de projets). Par exemple, un abonnement limité au projet A ne produira pas de notifications pour les événements publiés à partir du projet B.

scope: SubscriptionScope

Valeur de propriété

SubscriptionScope

status

Mise à jour de l’état de l’abonnement. Généralement utilisé pour activer ou désactiver un abonnement.

status: SubscriptionStatus

Valeur de propriété

SubscriptionStatus

statusMessage

Message facultatif qui fournit plus de détails sur l’état mis à jour.

statusMessage: string

Valeur de propriété

string

userSettings

Paramètres gérés par l’utilisateur pour l’abonnement. S’applique uniquement aux abonnements dont l’abonné fait partie d’un groupe. Généralement utilisé pour activer ou désactiver un utilisateur d’un abonnement de groupe.

userSettings: SubscriptionUserSettings

Valeur de propriété

SubscriptionUserSettings