NotificationSubscription interface

订阅定义了匹配事件的条件,以及如何通知订阅的订阅者有关这些事件。

属性

adminSettings

管理员订阅的托管设置。 仅在订阅者为组时适用。

channel

用于传递订阅触发的通知的通道。

description

订阅的说明。 通常描述有助于标识订阅的筛选条件。

diagnostics

此订阅的诊断。

extendedProperties

任何额外的属性,例如不同上下文、用户/组上下文的详细说明

filter

订阅的匹配条件。 ExpressionFilter

flags

进一步描述订阅的只读指示器。

id

订阅标识符。

lastModifiedBy

上次修改 (或) 订阅创建的用户。

modifiedDate

上次修改订阅的日期。 如果订阅自创建以来尚未更新,则此值将指示创建订阅的时间。

permissions

用户对此订阅拥有的权限。

scope

必须从中发布事件的容器,以便与订阅匹配。 如果为空,则作用域是当前主机 (通常是帐户或项目集合) 。 例如,范围限定为项目 A 的订阅不会为从项目 B 发布的事件生成通知。

status

订阅的状态。 通常指示是否启用订阅。

statusMessage

提供有关订阅状态的更多详细信息的消息。

subscriber

将接收与订阅筛选条件匹配的事件通知的用户或组。

url

订阅的 REST API URL。

userSettings

订阅的用户托管设置。 仅在订阅者为组时适用。 通常用于指示呼叫用户是选择加入还是退出组订阅。

属性详细信息

adminSettings

管理员订阅的托管设置。 仅在订阅者为组时适用。

adminSettings: SubscriptionAdminSettings

属性值

channel

用于传递订阅触发的通知的通道。

channel: ISubscriptionChannel

属性值

description

订阅的说明。 通常描述有助于标识订阅的筛选条件。

description: string

属性值

string

diagnostics

此订阅的诊断。

diagnostics: SubscriptionDiagnostics

属性值

extendedProperties

任何额外的属性,例如不同上下文、用户/组上下文的详细说明

extendedProperties: {[key: string]: string}

属性值

{[key: string]: string}

filter

订阅的匹配条件。 ExpressionFilter

filter: ISubscriptionFilter

属性值

flags

进一步描述订阅的只读指示器。

flags: SubscriptionFlags

属性值

id

订阅标识符。

id: string

属性值

string

lastModifiedBy

上次修改 (或) 订阅创建的用户。

lastModifiedBy: IdentityRef

属性值

modifiedDate

上次修改订阅的日期。 如果订阅自创建以来尚未更新,则此值将指示创建订阅的时间。

modifiedDate: Date

属性值

Date

permissions

用户对此订阅拥有的权限。

permissions: SubscriptionPermissions

属性值

scope

必须从中发布事件的容器,以便与订阅匹配。 如果为空,则作用域是当前主机 (通常是帐户或项目集合) 。 例如,范围限定为项目 A 的订阅不会为从项目 B 发布的事件生成通知。

scope: SubscriptionScope

属性值

status

订阅的状态。 通常指示是否启用订阅。

status: SubscriptionStatus

属性值

statusMessage

提供有关订阅状态的更多详细信息的消息。

statusMessage: string

属性值

string

subscriber

将接收与订阅筛选条件匹配的事件通知的用户或组。

subscriber: IdentityRef

属性值

url

订阅的 REST API URL。

url: string

属性值

string

userSettings

订阅的用户托管设置。 仅在订阅者为组时适用。 通常用于指示呼叫用户是选择加入还是退出组订阅。

userSettings: SubscriptionUserSettings

属性值