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	Admin verwaltete Einstellungen für das Abonnement. Gilt nur, wenn der Abonnent eine Gruppe ist.
channel	Kanal zum Übermitteln von Benachrichtigungen, die vom Abonnement ausgelöst werden.
description	Beschreibung des Abonnements. Beschreibt in der Regel Filterkriterien, die bei der Identität des Abonnements helfen.
diagnostics	Diagnose für dieses Abonnement.
extendedProperties	Alle zusätzlichen Eigenschaften wie detaillierte Beschreibung für verschiedene Kontexte, Benutzer-/Gruppenkontexte
filter	Abgleichskriterien für das Abonnement. ExpressionFilter
flags	Schreibgeschützte Indikatoren, die das Abonnement weiter beschreiben.
id	Abonnementbezeichner.
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, in dem Ereignisse veröffentlicht werden müssen, um vom Abonnement abgeglichen zu werden. Wenn leer, ist der Bereich der aktuelle Host (in der Regel ein Konto oder eine Projektsammlung). Beispielsweise erzeugt ein Abonnement, das auf Projekt A ausgerichtet ist, keine Benachrichtigungen für Ereignisse, die aus Projekt B veröffentlicht wurden.
status	Status des Abonnements. Gibt in der Regel an, ob das Abonnement aktiviert ist.
statusMessage	Meldung, die weitere Details zur 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	Vom Benutzer verwaltete Einstellungen für das Abonnement. Gilt nur, wenn der Abonnent eine Gruppe ist. Wird in der Regel verwendet, um anzugeben, ob der aufrufende Benutzer in oder aus einem Gruppenabonnement angemeldet ist.

Details zur Eigenschaft

adminSettings

Admin verwaltete Einstellungen für das Abonnement. Gilt nur, wenn der Abonnent eine Gruppe ist.

adminSettings: SubscriptionAdminSettings

Eigenschaftswert

SubscriptionAdminSettings

channel

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

channel: ISubscriptionChannel

Eigenschaftswert

ISubscriptionChannel

description

Beschreibung des Abonnements. Beschreibt in der Regel Filterkriterien, die bei der Identität des Abonnements helfen.

description: string

Eigenschaftswert

string

diagnostics

Diagnose für dieses Abonnement.

diagnostics: SubscriptionDiagnostics

Eigenschaftswert

SubscriptionDiagnostics

extendedProperties

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

extendedProperties: {[key: string]: string}

Eigenschaftswert

{[key: string]: string}

filter

Abgleichskriterien für das Abonnement. ExpressionFilter

filter: ISubscriptionFilter

Eigenschaftswert

ISubscriptionFilter

flags

Schreibgeschützte Indikatoren, die das Abonnement weiter beschreiben.

flags: SubscriptionFlags

Eigenschaftswert

SubscriptionFlags

id

Abonnementbezeichner.

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, in dem Ereignisse veröffentlicht werden müssen, um vom Abonnement abgeglichen zu werden. Wenn leer, ist der Bereich der aktuelle Host (in der Regel ein Konto oder eine Projektsammlung). Beispielsweise erzeugt ein Abonnement, das auf Projekt A ausgerichtet ist, keine Benachrichtigungen für Ereignisse, die aus Projekt B veröffentlicht wurden.

scope: SubscriptionScope

Eigenschaftswert

SubscriptionScope

status

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

status: SubscriptionStatus

Eigenschaftswert

SubscriptionStatus

statusMessage

Meldung, die weitere Details zur 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

Vom Benutzer verwaltete Einstellungen für das Abonnement. Gilt nur, wenn der Abonnent eine Gruppe ist. Wird in der Regel verwendet, um anzugeben, ob der aufrufende Benutzer in oder aus einem Gruppenabonnement angemeldet ist.

userSettings: SubscriptionUserSettings

Eigenschaftswert

SubscriptionUserSettings