NotificationSubscriptionUpdateParameters interface

Paket:

azure-devops-extension-api

Parametrar för uppdatering av en befintlig prenumeration. En prenumeration definierar kriterier för matchning av händelser och hur prenumerationens prenumerant ska meddelas om dessa händelser. Obs! Endast de fält som ska uppdateras ska anges.

Egenskaper

adminSettings	Administratörshanterade inställningar för prenumerationen. Gäller endast för prenumerationer där prenumeranten är en grupp.
channel	Kanal för att leverera meddelanden som utlöses av prenumerationen.
description	Uppdaterad beskrivning för prenumerationen. Beskriver vanligtvis filtervillkor som hjälper till att identifiera prenumerationen.
filter	Matchande villkor för prenumerationen. ExpressionFilter
scope	Containern där händelser måste publiceras från för att matchas av den nya prenumerationen. Om det inte anges är standardvärdet den aktuella värden (vanligtvis det aktuella kontot eller projektsamlingen). En prenumeration som är begränsad till projekt A kommer till exempel inte att generera meddelanden för händelser som publicerats från projekt B.
status	Prenumerationens status har uppdaterats. Används vanligtvis för att aktivera eller inaktivera en prenumeration.
statusMessage	Valfritt meddelande som innehåller mer information om den uppdaterade statusen.
userSettings	Användarhanterade inställningar för prenumerationen. Gäller endast för prenumerationer där prenumeranten är en grupp. Används vanligtvis för att anmäla eller välja bort en användare från en gruppprenumeration.

Egenskapsinformation

adminSettings

Administratörshanterade inställningar för prenumerationen. Gäller endast för prenumerationer dä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

Uppdaterad beskrivning för prenumerationen. Beskriver vanligtvis filtervillkor som hjälper till att identifiera prenumerationen.

description: string

Egenskapsvärde

string

filter

Matchande villkor för prenumerationen. ExpressionFilter

filter: ISubscriptionFilter

Egenskapsvärde

ISubscriptionFilter

scope

Containern där händelser måste publiceras från för att matchas av den nya prenumerationen. Om det inte anges är standardvärdet den aktuella värden (vanligtvis det aktuella kontot eller projektsamlingen). En prenumeration som är begränsad till projekt A kommer till exempel inte att generera meddelanden för händelser som publicerats från projekt B.

scope: SubscriptionScope

Egenskapsvärde

SubscriptionScope

status

Prenumerationens status har uppdaterats. Används vanligtvis för att aktivera eller inaktivera en prenumeration.

status: SubscriptionStatus

Egenskapsvärde

SubscriptionStatus

statusMessage

Valfritt meddelande som innehåller mer information om den uppdaterade statusen.

statusMessage: string

Egenskapsvärde

string

userSettings

Användarhanterade inställningar för prenumerationen. Gäller endast för prenumerationer där prenumeranten är en grupp. Används vanligtvis för att anmäla eller välja bort en användare från en gruppprenumeration.

userSettings: SubscriptionUserSettings

Egenskapsvärde

SubscriptionUserSettings