Subscriptions - Create Subscriptions Query
查詢服務攔截訂閱。
POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 『7.1』 以使用此版本的 API。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| consumerActionId |
string |
選擇性取用者動作識別碼，將結果限制為 （任何的 Null） |
| consumerId |
string |
選擇性取用者識別碼，將結果限制為 （任何的 null） |
| consumerInputFilters |
篩選訂用帳戶取用者輸入 |
|
| eventType |
string |
選擇性的事件類型識別碼，將結果限制為 （任何的 Null） |
| publisherId |
string |
選擇性發行者識別碼，將結果限制為 （任何的 null） |
| publisherInputFilters |
篩選訂閱發行者輸入 |
|
| results |
查詢的結果 |
|
| subscriberId |
string (uuid) |
選擇性訂閱者篩選。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
成功作業 |
安全性
oauth2
類型:
oauth2
Flow:
accessCode
授權 URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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
範圍
| 名稱 | 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” 字典中參考的 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 | |
| notEquals |
ReferenceLinks
表示 REST 參考連結集合的類別。
| 名稱 | 類型 | Description |
|---|---|---|
| links |
object |
連結的只讀檢視。 因為參考連結是只讀的，所以我們只想要將其公開為只讀。 |
Subscription
封裝事件訂閱。
| 名稱 | 類型 | Description |
|---|---|---|
| _links |
參考連結 |
|
| actionDescription |
string |
|
| consumerActionId |
string |
|
| consumerId |
string |
|
| consumerInputs |
object |
取用者輸入值 |
| createdBy | ||
| createdDate |
string (date-time) |
|
| eventDescription |
string |
|
| eventType |
string |
|
| id |
string (uuid) |
|
| lastProbationRetryDate |
string (date-time) |
|
| modifiedBy | ||
| modifiedDate |
string (date-time) |
|
| probationRetries |
string (byte) |
|
| 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 (uuid) |
選擇性訂閱者篩選。 |
SubscriptionStatus
| 值 | Description |
|---|---|
| disabledByInactiveIdentity |
訂用帳戶已停用，因為擁有者處於非使用中狀態或遺失許可權。 |
| disabledBySystem |
系統會停用訂用帳戶。 |
| disabledByUser |
使用者已停用訂用帳戶。 |
| enabled |
已啟用訂用帳戶。 |
| onProbation |
訂用帳戶暫時由系統緩刑。 |