NotificationSubscription interface

Paket:

azure-devops-extension-api

Ein Abonnement definiert Kriterien für übereinstimmende Ereignisse und wie der Abonnent des Abonnements über diese Ereignisse benachrichtigt werden soll.

Eigenschaften

adminSettings	Vom Administrator verwaltete Einstellungen für das Abonnement. Gilt nur, wenn es sich bei dem Abonnenten um eine Gruppe handelt.
channel	Kanal zum Übermitteln von Benachrichtigungen, die durch das Abonnement ausgelöst werden.
description	Beschreibung des Abonnements. Beschreibt in der Regel Filterkriterien, die zur Identifizierung des Abonnements beitragen.
diagnostics	Diagnose für dieses Abonnement.
extendedProperties	Alle zusätzlichen Eigenschaften wie detaillierte Beschreibungen für verschiedene Kontexte, Benutzer-/Gruppenkontexte
filter	Übereinstimmende Kriterien für das Abonnement. Ausdrucksfilter
flags	Schreibgeschützte Indikatoren, die das Abonnement weiter beschreiben.
id	Kennung des Abonnements.
lastModifiedBy	Benutzer, der das Abonnement zuletzt geändert (oder erstellt) hat.
modifiedDate	Datum, an dem das Abonnement zuletzt geändert wurde. Wenn das Abonnement seit seiner Erstellung nicht aktualisiert wurde, gibt dieser Wert an, wann das Abonnement erstellt wurde.
permissions	Die Berechtigungen, über die der Benutzer für diese Abonnements verfügt.
scope	Der Container, aus dem Ereignisse veröffentlicht werden müssen, damit sie mit dem Abonnement übereinstimmen. Wenn das Feld leer ist, handelt es sich bei dem Bereich um den aktuellen Host (in der Regel ein Konto oder eine Projektsammlung). Ein Abonnement, das auf Projekt A beschränkt ist, erzeugt z. B. keine Benachrichtigungen für Ereignisse, die von Projekt B veröffentlicht wurden.
status	Status des Abonnements. Gibt in der Regel an, ob das Abonnement aktiviert ist oder nicht.
statusMessage	Nachricht, die weitere Details zum Status des Abonnements enthält.
subscriber	Benutzer oder Gruppen, die Benachrichtigungen für Ereignisse erhalten, die den Filterkriterien des Abonnements entsprechen.
url	REST API URL des Abonnements.
userSettings	Benutzerverwaltete Einstellungen für das Abonnement. Gilt nur, wenn es sich bei dem Abonnenten um eine Gruppe handelt. Wird in der Regel verwendet, um anzugeben, ob der anrufende Benutzer für ein Gruppenabonnement an- oder abgemeldet ist.

Details zur Eigenschaft

adminSettings

Vom Administrator verwaltete Einstellungen für das Abonnement. Gilt nur, wenn es sich bei dem Abonnenten um eine Gruppe handelt.

adminSettings: SubscriptionAdminSettings

Eigenschaftswert

SubscriptionAdminSettings

channel

Kanal zum Übermitteln von Benachrichtigungen, die durch das Abonnement ausgelöst werden.

channel: ISubscriptionChannel

Eigenschaftswert

ISubscriptionChannel

description

Beschreibung des Abonnements. Beschreibt in der Regel Filterkriterien, die zur Identifizierung des Abonnements beitragen.

description: string

Eigenschaftswert

string

diagnostics

Diagnose für dieses Abonnement.

diagnostics: SubscriptionDiagnostics

Eigenschaftswert

SubscriptionDiagnostics

extendedProperties

Alle zusätzlichen Eigenschaften wie detaillierte Beschreibungen für verschiedene Kontexte, Benutzer-/Gruppenkontexte

extendedProperties: {[key: string]: string}

Eigenschaftswert

{[key: string]: string}

filter

Übereinstimmende Kriterien für das Abonnement. Ausdrucksfilter

filter: ISubscriptionFilter

Eigenschaftswert

ISubscriptionFilter

flags

Schreibgeschützte Indikatoren, die das Abonnement weiter beschreiben.

flags: SubscriptionFlags

Eigenschaftswert

SubscriptionFlags

id

Kennung des Abonnements.

id: string

Eigenschaftswert

string

lastModifiedBy

Benutzer, der das Abonnement zuletzt geändert (oder erstellt) hat.

lastModifiedBy: IdentityRef

Eigenschaftswert

IdentityRef

modifiedDate

Datum, an dem das Abonnement zuletzt geändert wurde. Wenn das Abonnement seit seiner Erstellung nicht aktualisiert wurde, gibt dieser Wert an, wann das Abonnement erstellt wurde.

modifiedDate: Date

Eigenschaftswert

Date

permissions

Die Berechtigungen, über die der Benutzer für diese Abonnements verfügt.

permissions: SubscriptionPermissions

Eigenschaftswert

SubscriptionPermissions

scope

Der Container, aus dem Ereignisse veröffentlicht werden müssen, damit sie mit dem Abonnement übereinstimmen. Wenn das Feld leer ist, handelt es sich bei dem Bereich um den aktuellen Host (in der Regel ein Konto oder eine Projektsammlung). Ein Abonnement, das auf Projekt A beschränkt ist, erzeugt z. B. keine Benachrichtigungen für Ereignisse, die von Projekt B veröffentlicht wurden.

scope: SubscriptionScope

Eigenschaftswert

SubscriptionScope

status

Status des Abonnements. Gibt in der Regel an, ob das Abonnement aktiviert ist oder nicht.

status: SubscriptionStatus

Eigenschaftswert

SubscriptionStatus

statusMessage

Nachricht, die weitere Details zum Status des Abonnements enthält.

statusMessage: string

Eigenschaftswert

string

subscriber

Benutzer oder Gruppen, die Benachrichtigungen für Ereignisse erhalten, die den Filterkriterien des Abonnements entsprechen.

subscriber: IdentityRef

Eigenschaftswert

IdentityRef

url

REST API URL des Abonnements.

url: string

Eigenschaftswert

string

userSettings

Benutzerverwaltete Einstellungen für das Abonnement. Gilt nur, wenn es sich bei dem Abonnenten um eine Gruppe handelt. Wird in der Regel verwendet, um anzugeben, ob der anrufende Benutzer für ein Gruppenabonnement an- oder abgemeldet ist.

userSettings: SubscriptionUserSettings

Eigenschaftswert

SubscriptionUserSettings