NotificationSubscriptionUpdateParameters interface

Package:

azure-devops-extension-api

Parameters for updating an existing subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events. Note: only the fields to be updated should be set.

Properties

adminSettings	Admin-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group.
channel	Channel for delivering notifications triggered by the subscription.
description	Updated description for the subscription. Typically describes filter criteria which helps identity the subscription.
filter	Matching criteria for the subscription. ExpressionFilter
scope	The container in which events must be published from in order to be matched by the new subscription. If not specified, defaults to the current host (typically the current account or project collection). For example, a subscription scoped to project A will not produce notifications for events published from project B.
status	Updated status for the subscription. Typically used to enable or disable a subscription.
statusMessage	Optional message that provides more details about the updated status.
userSettings	User-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group. Typically used to opt-in or opt-out a user from a group subscription.

Property Details

adminSettings

Admin-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group.

adminSettings: SubscriptionAdminSettings

Property Value

SubscriptionAdminSettings

channel

Channel for delivering notifications triggered by the subscription.

channel: ISubscriptionChannel

Property Value

ISubscriptionChannel

description

Updated description for the subscription. Typically describes filter criteria which helps identity the subscription.

description: string

Property Value

string

filter

Matching criteria for the subscription. ExpressionFilter

filter: ISubscriptionFilter

Property Value

ISubscriptionFilter

scope

The container in which events must be published from in order to be matched by the new subscription. If not specified, defaults to the current host (typically the current account or project collection). For example, a subscription scoped to project A will not produce notifications for events published from project B.

scope: SubscriptionScope

Property Value

SubscriptionScope

status

Updated status for the subscription. Typically used to enable or disable a subscription.

status: SubscriptionStatus

Property Value

SubscriptionStatus

statusMessage

Optional message that provides more details about the updated status.

statusMessage: string

Property Value

string

userSettings

User-managed settings for the subscription. Only applies to subscriptions where the subscriber is a group. Typically used to opt-in or opt-out a user from a group subscription.

userSettings: SubscriptionUserSettings

Property Value

SubscriptionUserSettings