NotificationSubscription interface

套件:

azure-devops-extension-api

訂用帳戶會定義比對事件的準則，以及訂用帳戶的訂閱者應如何收到有關這些事件的通知。

屬性

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

屬性值

SubscriptionAdminSettings

channel

用於傳遞訂用帳戶所觸發之通知的通道。

channel: ISubscriptionChannel

屬性值

ISubscriptionChannel

description

訂用帳戶的描述。 通常描述可協助識別訂用帳戶的篩選準則。

description: string

屬性值

string

diagnostics

此訂用帳戶的診斷。

diagnostics: SubscriptionDiagnostics

屬性值

SubscriptionDiagnostics

extendedProperties

任何額外的屬性，例如不同內容的詳細描述、使用者/群組內容

extendedProperties: {[key: string]: string}

屬性值

{[key: string]: string}

filter

訂用帳戶的比對準則。 ExpressionFilter

filter: ISubscriptionFilter

屬性值

ISubscriptionFilter

flags

進一步描述訂閱的唯讀指標。

flags: SubscriptionFlags

屬性值

SubscriptionFlags

id

訂閱識別碼。

id: string

屬性值

string

lastModifiedBy

上次修改 (或建立) 訂用帳戶的使用者。

lastModifiedBy: IdentityRef

屬性值

IdentityRef

modifiedDate

上次修改訂閱的日期。 如果訂閱自建立後尚未更新，此值將會指出建立訂閱的時間。

modifiedDate: Date

屬性值

Date

permissions

使用者為此訂用帳戶擁有的許可權。

permissions: SubscriptionPermissions

屬性值

SubscriptionPermissions

scope

必須從 中發佈事件的容器，才能與訂用帳戶相符。 如果空白，則範圍是目前的主機 (通常是帳戶或專案集合) 。 例如，範圍設定為專案 A 的訂用帳戶不會針對從專案 B 發佈的事件產生通知。

scope: SubscriptionScope

屬性值

SubscriptionScope

status

訂閱的狀態。 通常表示是否啟用訂用帳戶。

status: SubscriptionStatus

屬性值

SubscriptionStatus

statusMessage

訊息，提供有關訂用帳戶狀態的詳細資料。

statusMessage: string

屬性值

string

subscriber

將接收符合訂用帳戶篩選準則之事件通知的使用者或群組。

subscriber: IdentityRef

屬性值

IdentityRef

url

訂用帳戶的 REST API URL。

url: string

屬性值

string

userSettings

訂用帳戶的使用者管理設定。 只有在訂閱者是群組時才適用。 通常用來指出呼叫使用者是加入宣告或退出群組訂用帳戶。

userSettings: SubscriptionUserSettings

屬性值

SubscriptionUserSettings