NotificationSubscription interface

Pakiet:

azure-devops-extension-api

Subskrypcja definiuje kryteria dopasowania zdarzeń i sposobu powiadamiania subskrybenta subskrypcji o tych zdarzeniach.

Właściwości

adminSettings	Administracja ustawień zarządzanych dla subskrypcji. Ma zastosowanie tylko wtedy, gdy subskrybent jest grupą.
channel	Kanał do dostarczania powiadomień wyzwalanych przez subskrypcję.
description	Opis subskrypcji. Zazwyczaj opisuje kryteria filtrowania, które pomagają w tożsamości subskrypcji.
diagnostics	Diagnostyka dla tej subskrypcji.
extendedProperties	Wszelkie dodatkowe właściwości, takie jak szczegółowy opis dla różnych kontekstów, kontekstów użytkowników/grup
filter	Kryteria dopasowywania subskrypcji. ExpressionFilter
flags	Wskaźniki tylko do odczytu, które dodatkowo opisują subskrypcję.
id	Identyfikator subskrypcji.
lastModifiedBy	Użytkownik, który ostatnio zmodyfikował (lub utworzył) subskrypcję.
modifiedDate	Data ostatniej modyfikacji subskrypcji. Jeśli subskrypcja nie została zaktualizowana od czasu jej utworzenia, ta wartość będzie wskazywać, kiedy subskrypcja została utworzona.
permissions	Uprawnienia, które użytkownik ma dla tych subskrypcji.
scope	Kontener, z którego zdarzenia muszą być publikowane w celu dopasowania ich do subskrypcji. Jeśli jest pusty, zakres jest bieżącym hostem (zazwyczaj kontem lub kolekcją projektów). Na przykład subskrypcja o zakresie projektu A nie będzie generować powiadomień o zdarzeniach opublikowanych w projekcie B.
status	Stan subskrypcji. Zazwyczaj wskazuje, czy subskrypcja jest włączona, czy nie.
statusMessage	Komunikat zawierający więcej szczegółów na temat stanu subskrypcji.
subscriber	Użytkownik lub grupa, która będzie otrzymywać powiadomienia o zdarzeniach spełniających kryteria filtrowania subskrypcji.
url	Adres URL interfejsu API REST subskrypcji.
userSettings	Ustawienia zarządzane przez użytkownika dla subskrypcji. Ma zastosowanie tylko wtedy, gdy subskrybent jest grupą. Zazwyczaj służy do wskazywania, czy użytkownik wywołujący jest optyzowany, czy nie jest subskrypcją grupy.

Szczegóły właściwości

adminSettings

Administracja ustawień zarządzanych dla subskrypcji. Ma zastosowanie tylko wtedy, gdy subskrybent jest grupą.

adminSettings: SubscriptionAdminSettings

Wartość właściwości

SubscriptionAdminSettings

channel

Kanał do dostarczania powiadomień wyzwalanych przez subskrypcję.

channel: ISubscriptionChannel

Wartość właściwości

ISubscriptionChannel

description

Opis subskrypcji. Zazwyczaj opisuje kryteria filtrowania, które pomagają w tożsamości subskrypcji.

description: string

Wartość właściwości

string

diagnostics

Diagnostyka dla tej subskrypcji.

diagnostics: SubscriptionDiagnostics

Wartość właściwości

SubscriptionDiagnostics

extendedProperties

Wszelkie dodatkowe właściwości, takie jak szczegółowy opis dla różnych kontekstów, kontekstów użytkowników/grup

extendedProperties: {[key: string]: string}

Wartość właściwości

{[key: string]: string}

filter

Kryteria dopasowywania subskrypcji. ExpressionFilter

filter: ISubscriptionFilter

Wartość właściwości

ISubscriptionFilter

flags

Wskaźniki tylko do odczytu, które dodatkowo opisują subskrypcję.

flags: SubscriptionFlags

Wartość właściwości

SubscriptionFlags

id

Identyfikator subskrypcji.

id: string

Wartość właściwości

string

lastModifiedBy

Użytkownik, który ostatnio zmodyfikował (lub utworzył) subskrypcję.

lastModifiedBy: IdentityRef

Wartość właściwości

IdentityRef

modifiedDate

Data ostatniej modyfikacji subskrypcji. Jeśli subskrypcja nie została zaktualizowana od czasu jej utworzenia, ta wartość będzie wskazywać, kiedy subskrypcja została utworzona.

modifiedDate: Date

Wartość właściwości

Date

permissions

Uprawnienia, które użytkownik ma dla tych subskrypcji.

permissions: SubscriptionPermissions

Wartość właściwości

SubscriptionPermissions

scope

Kontener, z którego zdarzenia muszą być publikowane w celu dopasowania ich do subskrypcji. Jeśli jest pusty, zakres jest bieżącym hostem (zazwyczaj kontem lub kolekcją projektów). Na przykład subskrypcja o zakresie projektu A nie będzie generować powiadomień o zdarzeniach opublikowanych w projekcie B.

scope: SubscriptionScope

Wartość właściwości

SubscriptionScope

status

Stan subskrypcji. Zazwyczaj wskazuje, czy subskrypcja jest włączona, czy nie.

status: SubscriptionStatus

Wartość właściwości

SubscriptionStatus

statusMessage

Komunikat zawierający więcej szczegółów na temat stanu subskrypcji.

statusMessage: string

Wartość właściwości

string

subscriber

Użytkownik lub grupa, która będzie otrzymywać powiadomienia o zdarzeniach spełniających kryteria filtrowania subskrypcji.

subscriber: IdentityRef

Wartość właściwości

IdentityRef

url

Adres URL interfejsu API REST subskrypcji.

url: string

Wartość właściwości

string

userSettings

Ustawienia zarządzane przez użytkownika dla subskrypcji. Ma zastosowanie tylko wtedy, gdy subskrybent jest grupą. Zazwyczaj służy do wskazywania, czy użytkownik wywołujący jest optyzowany, czy nie jest subskrypcją grupy.

userSettings: SubscriptionUserSettings

Wartość właściwości

SubscriptionUserSettings