NotificationSubscriptionCreateParameters interface

Package:

azure-devops-extension-api

Parameters for creating a new subscription. A subscription defines criteria for matching events and how the subscription's subscriber should be notified about those events.

Properties

channel	Channel for delivering notifications triggered by the new subscription.
description	Brief description for the new subscription. Typically describes filter criteria which helps identity the subscription.
filter	Matching criteria for the new 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 an account or project collection). For example, a subscription scoped to project A will not produce notifications for events published from project B.
subscriber	User or group that will receive notifications for events matching the subscription's filter criteria. If not specified, defaults to the calling user.

Property Details

channel

Channel for delivering notifications triggered by the new subscription.

channel: ISubscriptionChannel

Property Value

ISubscriptionChannel

description

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

description: string

Property Value

string

filter

Matching criteria for the new 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 an 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

subscriber

User or group that will receive notifications for events matching the subscription's filter criteria. If not specified, defaults to the calling user.

subscriber: IdentityRef

Property Value

IdentityRef