NotificationSubscriptionUpdateParameters interface

Paket:

azure-devops-extension-api

Parameter zum Aktualisieren eines vorhandenen Abonnements. Ein Abonnement definiert Kriterien für übereinstimmende Ereignisse und wie der Abonnent des Abonnements über diese Ereignisse benachrichtigt werden soll. Hinweis: Es sollten nur die zu aktualisierenden Felder festgelegt werden.

Eigenschaften

adminSettings	Vom Administrator verwaltete Einstellungen für das Abonnement. Gilt nur für Abonnements, bei denen der Abonnent eine Gruppe ist.
channel	Kanal für die Übermittlung von Benachrichtigungen, die vom Abonnement ausgelöst werden.
description	Aktualisierte Beschreibung für das Abonnement. Beschreibt in der Regel Filterkriterien, die das Abonnement identifizieren können.
filter	Übereinstimmende Kriterien für das Abonnement. ExpressionFilter
scope	Der Container, in dem Ereignisse veröffentlicht werden müssen, um mit dem neuen Abonnement übereinstimmen zu können. Wenn nicht angegeben, wird standardmäßig der aktuelle Host (in der Regel das aktuelle Konto oder die Projektsammlung) verwendet. Beispielsweise erzeugt ein Abonnement, das auf Projekt A festgelegt ist, keine Benachrichtigungen für Ereignisse, die aus Projekt B veröffentlicht wurden.
status	Aktualisierter Status für das Abonnement. Wird in der Regel verwendet, um ein Abonnement zu aktivieren oder zu deaktivieren.
statusMessage	Optionale Meldung, die weitere Details zum aktualisierten Status bereitstellt.
userSettings	Vom Benutzer verwaltete Einstellungen für das Abonnement. Gilt nur für Abonnements, bei denen der Abonnent eine Gruppe ist. Wird in der Regel verwendet, um einen Benutzer aus einem Gruppenabonnement abzumelden oder abzumelden.

Details zur Eigenschaft

adminSettings

Vom Administrator verwaltete Einstellungen für das Abonnement. Gilt nur für Abonnements, bei denen der Abonnent eine Gruppe ist.

adminSettings: SubscriptionAdminSettings

Eigenschaftswert

SubscriptionAdminSettings

channel

Kanal für die Übermittlung von Benachrichtigungen, die vom Abonnement ausgelöst werden.

channel: ISubscriptionChannel

Eigenschaftswert

ISubscriptionChannel

description

Aktualisierte Beschreibung für das Abonnement. Beschreibt in der Regel Filterkriterien, die das Abonnement identifizieren können.

description: string

Eigenschaftswert

string

filter

Übereinstimmende Kriterien für das Abonnement. ExpressionFilter

filter: ISubscriptionFilter

Eigenschaftswert

ISubscriptionFilter

scope

Der Container, in dem Ereignisse veröffentlicht werden müssen, um mit dem neuen Abonnement übereinstimmen zu können. Wenn nicht angegeben, wird standardmäßig der aktuelle Host (in der Regel das aktuelle Konto oder die Projektsammlung) verwendet. Beispielsweise erzeugt ein Abonnement, das auf Projekt A festgelegt ist, keine Benachrichtigungen für Ereignisse, die aus Projekt B veröffentlicht wurden.

scope: SubscriptionScope

Eigenschaftswert

SubscriptionScope

status

Aktualisierter Status für das Abonnement. Wird in der Regel verwendet, um ein Abonnement zu aktivieren oder zu deaktivieren.

status: SubscriptionStatus

Eigenschaftswert

SubscriptionStatus

statusMessage

Optionale Meldung, die weitere Details zum aktualisierten Status bereitstellt.

statusMessage: string

Eigenschaftswert

string

userSettings

Vom Benutzer verwaltete Einstellungen für das Abonnement. Gilt nur für Abonnements, bei denen der Abonnent eine Gruppe ist. Wird in der Regel verwendet, um einen Benutzer aus einem Gruppenabonnement abzumelden oder abzumelden.

userSettings: SubscriptionUserSettings

Eigenschaftswert

SubscriptionUserSettings