Subscriptions - Create Subscriptions Query
查詢服務攔截訂閱。
POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1-preview.1URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '7.1-preview.1' 以使用此版本的 API。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| consumerActionId |
string |
選擇性取用者動作識別碼，可將結果限制為任何) (null |
| consumerId |
string |
選擇性取用者識別碼，可將結果限制為任何) (null |
| consumerInputFilters |
篩選訂用帳戶取用者輸入 |
|
| eventType |
string |
選擇性事件種類識別碼，可將結果限制為任何) 的 null ( |
| publisherId |
string |
選擇性發行者識別碼，可將結果限制為任何) (null |
| publisherInputFilters |
篩選訂閱發行者輸入 |
|
| results |
查詢的結果 |
|
| subscriberId |
string |
選擇性訂閱者篩選。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功的作業 |
安全性
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
| 名稱 | Description |
|---|---|
| vso.work | 授與讀取工作專案、查詢、面板、區域和反復專案路徑，以及其他工作專案追蹤相關中繼資料的能力。 也授與執行查詢、搜尋工作專案，以及透過服務勾點接收工作專案事件通知的能力。 |
| vso.build | 授與存取組建成品的能力，包括建置結果、定義和要求，以及透過服務勾點接收建置事件相關通知的能力。 |
| vso.code | 授與讀取認可、變更集、分支和其他版本控制成品之原始程式碼和中繼資料的能力。 也授與搜尋程式碼的能力，並透過服務勾點取得版本控制事件的通知。 |
定義
| 名稱 | Description |
|---|---|
|
Identity |
|
|
Input |
定義訂用帳戶輸入的篩選準則。 如果一或多個群組 (一或多個群組) 評估為 true，篩選準則就會比對一組輸入。 |
|
Input |
可用來篩選訂用帳戶輸入清單的運算式 |
|
Input |
在預期的和實際輸入值之間套用的運算子 |
|
Reference |
表示 REST 參考連結集合的類別。 |
| Subscription |
封裝事件訂閱。 |
|
Subscriptions |
定義服務攔截訂閱的查詢。 |
|
Subscription |
IdentityRef
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。 |
|
| descriptor |
string |
描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。 |
| directoryAlias |
string |
已淘汰 - 藉由查詢 IdentityRef 「_links」 字典之 「self」 專案中參考的 Graph 使用者，即可擷取 |
| displayName |
string |
這是圖表主旨的非唯一顯示名稱。 若要變更此欄位，您必須在來源提供者中變更其值。 |
| id |
string |
|
| imageUrl |
string |
已淘汰 - 可在 IdentityRef 「_links」 字典的 「avatar」 專案中使用 |
| inactive |
boolean |
已淘汰 - 您可以查詢 GraphUser 「_links」 字典之 「membershipState」 專案中參考的 Graph 成員資格狀態來擷取 |
| isAadIdentity |
boolean |
已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
已淘汰 - 未在 ToIdentityRef 的大多數預先存在實作中使用 |
| uniqueName |
string |
已淘汰 - 請改用 Domain+PrincipalName |
| url |
string |
此 URL 是此圖表主體來源資源的完整路由。 |
InputFilter
定義訂用帳戶輸入的篩選準則。 如果一或多個群組 (一或多個群組) 評估為 true，篩選準則就會比對一組輸入。
| 名稱 | 類型 | Description |
|---|---|---|
| conditions |
輸入篩選運算式的群組。 如果一或多個群組 (一或多個群組) 評估為 true，則此篩選準則會比對一組輸入。 |
InputFilterCondition
可用來篩選訂用帳戶輸入清單的運算式
| 名稱 | 類型 | Description |
|---|---|---|
| caseSensitive |
boolean |
是否要執行區分大小寫的相符專案 |
| inputId |
string |
要篩選的輸入識別碼 |
| inputValue |
string |
要與實際輸入值比較的「預期」輸入值 |
| operator |
在預期的和實際輸入值之間套用的運算子 |
InputFilterOperator
在預期的和實際輸入值之間套用的運算子
| 名稱 | 類型 | Description |
|---|---|---|
| equals |
string |
|
| notEquals |
string |
ReferenceLinks
表示 REST 參考連結集合的類別。
| 名稱 | 類型 | Description |
|---|---|---|
| links |
object |
連結的唯讀檢視。 因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。 |
Subscription
封裝事件訂閱。
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
參考連結 |
|
| actionDescription |
string |
|
| consumerActionId |
string |
|
| consumerId |
string |
|
| consumerInputs |
object |
取用者輸入值 |
| createdBy | ||
| createdDate |
string |
|
| eventDescription |
string |
|
| eventType |
string |
|
| id |
string |
|
| lastProbationRetryDate |
string |
|
| modifiedBy | ||
| modifiedDate |
string |
|
| probationRetries |
string |
|
| publisherId |
string |
|
| publisherInputs |
object |
發行者輸入值 |
| resourceVersion |
string |
|
| status | ||
| subscriber | ||
| url |
string |
SubscriptionsQuery
定義服務攔截訂閱的查詢。
| 名稱 | 類型 | Description |
|---|---|---|
| consumerActionId |
string |
選擇性取用者動作識別碼，可將結果限制為任何) (null |
| consumerId |
string |
選擇性取用者識別碼，可將結果限制為任何) (null |
| consumerInputFilters |
篩選訂用帳戶取用者輸入 |
|
| eventType |
string |
選擇性事件種類識別碼，可將結果限制為任何) 的 null ( |
| publisherId |
string |
選擇性發行者識別碼，可將結果限制為任何) (null |
| publisherInputFilters |
篩選訂閱發行者輸入 |
|
| results |
查詢的結果 |
|
| subscriberId |
string |
選擇性訂閱者篩選。 |
SubscriptionStatus
| 名稱 | 類型 | Description |
|---|---|---|
| disabledByInactiveIdentity |
string |
訂用帳戶已停用，因為擁有者處於非使用中狀態或缺少許可權。 |
| disabledBySystem |
string |
系統會停用訂用帳戶。 |
| disabledByUser |
string |
使用者已停用訂閱。 |
| enabled |
string |
訂用帳戶已啟用。 |
| onProbation |
string |
訂閱會暫時由系統進行探查。 |