NotificationSubscription interface

Balíček:

azure-devops-extension-api

Předplatné definuje kritéria pro odpovídající události a způsob, jakým by měl být odběratel předplatného upozorněn na tyto události.

Vlastnosti

adminSettings	Nastavení spravovaná správcem pro předplatné Platí jenom v případech, kdy je odběratelem skupina.
channel	Kanál pro doručování oznámení aktivovaných předplatným
description	Popis předplatného Obvykle popisuje kritéria filtru, která pomáhají s identitou předplatného.
diagnostics	Diagnostika pro toto předplatné
extendedProperties	Všechny další vlastnosti, jako je podrobný popis pro různé kontexty, kontexty uživatelů a skupin
filter	Odpovídající kritéria pro předplatné ExpressionFilter
flags	Indikátory jen pro čtení, které dále popisují předplatné.
id	Identifikátor předplatného.
lastModifiedBy	Uživatel, který naposledy změnil (nebo vytvořil) předplatné.
modifiedDate	Datum poslední změny předplatného Pokud se předplatné od vytvoření neaktualizovalo, bude tato hodnota značovat, kdy se předplatné vytvořilo.
permissions	Oprávnění, která má uživatel pro tato předplatná.
scope	Kontejner, ve kterém musí být události publikovány, aby se shodovaly s předplatným. Pokud je obor prázdný, jedná se o aktuálního hostitele (obvykle účet nebo kolekci projektů). Například odběr vymezený na projekt A nebude vytvářet oznámení o událostech publikovaných z projektu B.
status	Stav předplatného Obvykle označuje, jestli je předplatné povolené, nebo ne.
statusMessage	Zpráva s dalšími podrobnostmi o stavu předplatného
subscriber	Uživatel nebo skupina, která obdrží oznámení o událostech odpovídajících kritériím filtru odběru.
url	Adresa URL rozhraní REST API předplatného
userSettings	Nastavení spravovaná uživatelem pro předplatné Platí jenom v případech, kdy je odběratelem skupina. Obvykle se používá k označení, jestli je volající uživatel přihlášený nebo mimo předplatné skupiny.

Podrobnosti vlastnosti

adminSettings

Nastavení spravovaná správcem pro předplatné Platí jenom v případech, kdy je odběratelem skupina.

adminSettings: SubscriptionAdminSettings

Hodnota vlastnosti

SubscriptionAdminSettings

channel

Kanál pro doručování oznámení aktivovaných předplatným

channel: ISubscriptionChannel

Hodnota vlastnosti

ISubscriptionChannel

description

Popis předplatného Obvykle popisuje kritéria filtru, která pomáhají s identitou předplatného.

description: string

Hodnota vlastnosti

string

diagnostics

Diagnostika pro toto předplatné

diagnostics: SubscriptionDiagnostics

Hodnota vlastnosti

SubscriptionDiagnostics

extendedProperties

Všechny další vlastnosti, jako je podrobný popis pro různé kontexty, kontexty uživatelů a skupin

extendedProperties: {[key: string]: string}

Hodnota vlastnosti

{[key: string]: string}

filter

Odpovídající kritéria pro předplatné ExpressionFilter

filter: ISubscriptionFilter

Hodnota vlastnosti

ISubscriptionFilter

flags

Indikátory jen pro čtení, které dále popisují předplatné.

flags: SubscriptionFlags

Hodnota vlastnosti

SubscriptionFlags

id

Identifikátor předplatného.

id: string

Hodnota vlastnosti

string

lastModifiedBy

Uživatel, který naposledy změnil (nebo vytvořil) předplatné.

lastModifiedBy: IdentityRef

Hodnota vlastnosti

IdentityRef

modifiedDate

Datum poslední změny předplatného Pokud se předplatné od vytvoření neaktualizovalo, bude tato hodnota značovat, kdy se předplatné vytvořilo.

modifiedDate: Date

Hodnota vlastnosti

Date

permissions

Oprávnění, která má uživatel pro tato předplatná.

permissions: SubscriptionPermissions

Hodnota vlastnosti

SubscriptionPermissions

scope

Kontejner, ve kterém musí být události publikovány, aby se shodovaly s předplatným. Pokud je obor prázdný, jedná se o aktuálního hostitele (obvykle účet nebo kolekci projektů). Například odběr vymezený na projekt A nebude vytvářet oznámení o událostech publikovaných z projektu B.

scope: SubscriptionScope

Hodnota vlastnosti

SubscriptionScope

status

Stav předplatného Obvykle označuje, jestli je předplatné povolené, nebo ne.

status: SubscriptionStatus

Hodnota vlastnosti

SubscriptionStatus

statusMessage

Zpráva s dalšími podrobnostmi o stavu předplatného

statusMessage: string

Hodnota vlastnosti

string

subscriber

Uživatel nebo skupina, která obdrží oznámení o událostech odpovídajících kritériím filtru odběru.

subscriber: IdentityRef

Hodnota vlastnosti

IdentityRef

url

Adresa URL rozhraní REST API předplatného

url: string

Hodnota vlastnosti

string

userSettings

Nastavení spravovaná uživatelem pro předplatné Platí jenom v případech, kdy je odběratelem skupina. Obvykle se používá k označení, jestli je volající uživatel přihlášený nebo mimo předplatné skupiny.

userSettings: SubscriptionUserSettings

Hodnota vlastnosti

SubscriptionUserSettings