NotificationSubscription interface

Paket:

azure-devops-extension-api

En prenumeration definierar kriterier för matchning av händelser och hur prenumerationens prenumerant ska meddelas om dessa händelser.

Egenskaper

adminSettings	Admin hanterade inställningar för prenumerationen. Gäller endast när prenumeranten är en grupp.
channel	Kanal för att leverera meddelanden som utlöses av prenumerationen.
description	Beskrivning av prenumerationen. Beskriver vanligtvis filterkriterier som hjälper till att identifiera prenumerationen.
diagnostics	Diagnostik för den här prenumerationen.
extendedProperties	Eventuella extra egenskaper som detaljerad beskrivning för olika kontexter, användar-/gruppkontexter
filter	Matchningsvillkor för prenumerationen. ExpressionFilter
flags	Skrivskyddade indikatorer som ytterligare beskriver prenumerationen.
id	Prenumerationsidentifierare.
lastModifiedBy	Användare som senast ändrade (eller skapade) prenumerationen.
modifiedDate	Datum då prenumerationen senast ändrades. Om prenumerationen inte har uppdaterats sedan den skapades anger det här värdet när prenumerationen skapades.
permissions	De behörigheter som användaren har för de här prenumerationerna.
scope	Containern där händelser måste publiceras från för att matchas av prenumerationen. Om den är tom är omfånget den aktuella värden (vanligtvis ett konto eller en projektsamling). Till exempel kommer en prenumeration som är begränsad till projekt A inte att generera meddelanden för händelser som publicerats från projekt B.
status	Status för prenumerationen. Anger vanligtvis om prenumerationen är aktiverad eller inte.
statusMessage	Meddelande som innehåller mer information om prenumerationens status.
subscriber	Användare eller grupp som får meddelanden om händelser som matchar prenumerationens filtervillkor.
url	REST API-URL för prenumerationen.
userSettings	Användarhanterade inställningar för prenumerationen. Gäller endast när prenumeranten är en grupp. Används vanligtvis för att ange om den anropande användaren är anmäld till eller från en gruppprenumeration.

Egenskapsinformation

adminSettings

Admin hanterade inställningar för prenumerationen. Gäller endast när prenumeranten är en grupp.

adminSettings: SubscriptionAdminSettings

Egenskapsvärde

SubscriptionAdminSettings

channel

Kanal för att leverera meddelanden som utlöses av prenumerationen.

channel: ISubscriptionChannel

Egenskapsvärde

ISubscriptionChannel

description

Beskrivning av prenumerationen. Beskriver vanligtvis filterkriterier som hjälper till att identifiera prenumerationen.

description: string

Egenskapsvärde

string

diagnostics

Diagnostik för den här prenumerationen.

diagnostics: SubscriptionDiagnostics

Egenskapsvärde

SubscriptionDiagnostics

extendedProperties

Eventuella extra egenskaper som detaljerad beskrivning för olika kontexter, användar-/gruppkontexter

extendedProperties: {[key: string]: string}

Egenskapsvärde

{[key: string]: string}

filter

Matchningsvillkor för prenumerationen. ExpressionFilter

filter: ISubscriptionFilter

Egenskapsvärde

ISubscriptionFilter

flags

Skrivskyddade indikatorer som ytterligare beskriver prenumerationen.

flags: SubscriptionFlags

Egenskapsvärde

SubscriptionFlags

id

Prenumerationsidentifierare.

id: string

Egenskapsvärde

string

lastModifiedBy

Användare som senast ändrade (eller skapade) prenumerationen.

lastModifiedBy: IdentityRef

Egenskapsvärde

IdentityRef

modifiedDate

Datum då prenumerationen senast ändrades. Om prenumerationen inte har uppdaterats sedan den skapades anger det här värdet när prenumerationen skapades.

modifiedDate: Date

Egenskapsvärde

Date

permissions

De behörigheter som användaren har för de här prenumerationerna.

permissions: SubscriptionPermissions

Egenskapsvärde

SubscriptionPermissions

scope

Containern där händelser måste publiceras från för att matchas av prenumerationen. Om den är tom är omfånget den aktuella värden (vanligtvis ett konto eller en projektsamling). Till exempel kommer en prenumeration som är begränsad till projekt A inte att generera meddelanden för händelser som publicerats från projekt B.

scope: SubscriptionScope

Egenskapsvärde

SubscriptionScope

status

Status för prenumerationen. Anger vanligtvis om prenumerationen är aktiverad eller inte.

status: SubscriptionStatus

Egenskapsvärde

SubscriptionStatus

statusMessage

Meddelande som innehåller mer information om prenumerationens status.

statusMessage: string

Egenskapsvärde

string

subscriber

Användare eller grupp som får meddelanden om händelser som matchar prenumerationens filtervillkor.

subscriber: IdentityRef

Egenskapsvärde

IdentityRef

url

REST API-URL för prenumerationen.

url: string

Egenskapsvärde

string

userSettings

Användarhanterade inställningar för prenumerationen. Gäller endast när prenumeranten är en grupp. Används vanligtvis för att ange om den anropande användaren är anmäld till eller från en gruppprenumeration.

userSettings: SubscriptionUserSettings

Egenskapsvärde

SubscriptionUserSettings