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	Ustawienia zarządzane przez administratora dla subskrypcji. Ma zastosowanie tylko wtedy, gdy subskrybent jest grupą.
channel	Kanał dostarczania powiadomień wyzwalanych przez subskrypcję.
description	Opis subskrypcji. Zazwyczaj opisuje kryteria filtrowania, które pomagają zidentyfikować subskrypcję.
diagnostics	Diagnostyka dla tej subskrypcji.
extendedProperties	Wszelkie dodatkowe właściwości, takie jak szczegółowy opis dla różnych kontekstów, konteksty użytkownika/grupy
filter	Kryteria dopasowania dla subskrypcji. Filtr wyrażeń
flags	Wskaźniki tylko do odczytu, które dokładniej opisują subskrypcję.
id	Identyfikator subskrypcji.
lastModifiedBy	Użytkownik, który jako ostatni 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, w którym muszą być publikowane zdarzenia, aby były zgodne z subskrypcją. Jeśli pole jest puste, zakres jest bieżącym hostem (zazwyczaj jest to konto lub kolekcja projektów). Na przykład subskrypcja o zakresie projektu A nie będzie generować powiadomień o zdarzeniach opublikowanych z projektu B.
status	Status 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 włączony do subskrypcji grupowej, czy z niej zrezygnowany.

Szczegóły właściwości

adminSettings

Ustawienia zarządzane przez administratora dla subskrypcji. Ma zastosowanie tylko wtedy, gdy subskrybent jest grupą.

adminSettings: SubscriptionAdminSettings

Wartość właściwości

SubscriptionAdminSettings

channel

Kanał dostarczania powiadomień wyzwalanych przez subskrypcję.

channel: ISubscriptionChannel

Wartość właściwości

ISubscriptionChannel

description

Opis subskrypcji. Zazwyczaj opisuje kryteria filtrowania, które pomagają zidentyfikować subskrypcję.

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, konteksty użytkownika/grupy

extendedProperties: {[key: string]: string}

Wartość właściwości

{[key: string]: string}

filter

Kryteria dopasowania dla subskrypcji. Filtr wyrażeń

filter: ISubscriptionFilter

Wartość właściwości

ISubscriptionFilter

flags

Wskaźniki tylko do odczytu, które dokładniej 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 jako ostatni 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, w którym muszą być publikowane zdarzenia, aby były zgodne z subskrypcją. Jeśli pole jest puste, zakres jest bieżącym hostem (zazwyczaj jest to konto lub kolekcja projektów). Na przykład subskrypcja o zakresie projektu A nie będzie generować powiadomień o zdarzeniach opublikowanych z projektu B.

scope: SubscriptionScope

Wartość właściwości

SubscriptionScope

status

Status 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 włączony do subskrypcji grupowej, czy z niej zrezygnowany.

userSettings: SubscriptionUserSettings

Wartość właściwości

SubscriptionUserSettings