Azure DevOps
Azure DevOps 提供服務,讓小組共用程式代碼、追蹤工作,以及發佈軟體 - 適用於任何語言,全部都在單一套件中。 它是對 IDE 的完美補充。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連接器中繼資料 | |
|---|---|
| Publisher | Microsoft |
若要使用此整合,您必須存取已啟用 API 存取的 Azure DevOps 帳戶。 若要建立連線,請選取 [登入]。 然後,系統會提示您提供 Azure DevOps Services 帳戶。 按照其餘的屏幕創建連接。
使用連線時,如果您沒有看到預期的專案清單,請檢查您建立連線的帳戶,然後重試。 如需更多詳細資料,請參閱 Visual Studio Marketplace。
您現在已準備好開始使用此整合。
傳送附件
您可以使用 [將 HTTP 要求傳送至 Azure DevOps 動作] 來建立檔案附件,然後遵循下列步驟:
- 將文件內容轉換為 Base64 字符串並將其放入“Body”參數中。
- 將「Body is Base64」參數設定為是。
建立測試計劃
使用 [ 建立工作專案 ] 動作建立測試計劃之前,您必須先建立測試套組。 您可以使用相同的 [ 建立工作專案 ] 動作來建立測試套件,然後建立具有測試套件連結的測試計劃。
最簡單的選項是使用 [將 HTTP 要求傳送至 Azure DevOps 動作] 直接叫用 Test Plans - 建立 API。 API 會自動建立相關聯的測試套件。
其他欄位參數
建立工作專案 和 更新工作專案 動作支援 Other Fields 參數。 這些欄位在更新工作專案時提供額外的彈性。 鍵值組會轉換為下列 JSON:
{
"op": "add",
"path": "/fields/<key>",
"value": <value>
}
請注意,這是 op 常數,而且 <key> 預期是 DevOps /fields 列舉下的有效欄位名稱。
以下是一些使用範例。 您可以在 工作專案 - 更新 REST API 中精細化更多範例。
- 歷程記錄更新
key= System.Historyvalue= 移至正確的區域路徑' - 移動工作專案:
key= System.TeamProjectvalue= Fabrikam-Scrum
已知問題和限制
下列清單提供使用 Azure DevOps 連接器的已知限制。
觸發程序 當 工作專案更新時 ,將會在新增/刪除工作專案時略過新的/現有連結。
動作: 取得工作專案詳細數據 和工作專案型觸發程式可能會遺漏回應中的某些欄位 (,例如 System.AttachedFileCount) ,因為這是 Azure DevOps REST API 的限制。 若要解決此問題,您可以執行下列其中一項:
- 使用 將 HTTP 要求傳送至 Azure DevOps 搭配 [取得工作專案 ] 端點來取得特定欄位
- 將 取得查詢結果 與傳回必要欄位的查詢搭配使用
動作 :將 HTTP 要求傳送至 Azure DevOps 有一組有限的範圍,可控制動作可以存取哪些資源,以及允許動作在這些資源上執行哪些作業。
範圍:
- vso.agentpools_manage
- vso.build_execute
- vso.chat_manage
- vso.code_manage
- vso.code_status
- vso.connected_server
- 儀表板管理
- vso.權利
- vso.extension.data_write
- vso.extension_manage
- vso.identity
- vso.loadtest_write
- vso.packaging_manage
- vso.專案管理
- vso.釋出管理
- vso.test_write
- vso.work_write
Azure DevOps 連接器的設計目的是僅代表目前的使用者認證運作。 無法更改連接或在帳戶之間切換。
請注意,Azure DevOps 帳戶下的密碼變更不會影響現有的連線。
不支援使用 Azure DevOps 個人存取權杖進行連接器驗證。
動作 建立工作專案 重現步驟參數有限制 - 大於 30 KB 的影像可能會在建立的專案中不正確顯示。 大於 500Kb 的圖像可以從請求中刪除。 建議的影像大小應小於 30 KB。
動作 建立工作專案 很少會傳回 404 回應程式代碼。 最常見的是,發生這種情況的原因如下:建立項目後,立即請求其所有欄位。 請求可以傳送到複製的資料庫。 這些變更幾乎是即時同步的,但有時需要幾秒鐘。 因此,GET 要求可能會傳回空白結果,在回應中表示為 404 狀態碼。 若要避免此異常,您可以使用「傳回所有欄位」標誌並將其設定為「否」值。
如果您在使用多個目錄時未取得預期的組織,請從 Azure DevOps 配置檔頁面 選擇您預期的組織,並設定新的連線。
備註
在 [建立工作專案] 動作中
- 欄位名稱必須符合 Azure DevOps 檔中所述的準則。
正在建立連線
連接器支援下列驗證類型:
| 用戶端憑證驗證 | 使用 PFX 憑證和密碼提供 Microsoft Entra ID 認證 | 所有區域 | 可共用 |
| 使用 Microsoft Entra ID 登入 | 使用 Microsoft Entra ID 登入 | 僅限生產 | 不可共享 |
| 服務主體帳戶驗證 | 使用 Microsoft Entra ID 應用程式進行服務主體驗證 | 所有區域 | 可共用 |
| 預設值 [已棄用] | 此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。 | 所有區域 | 不可共享 |
用戶端憑證驗證
驗證 ID:CertOauth
適用:所有地區
使用 PFX 憑證和密碼提供 Microsoft Entra ID 認證
這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 租戶 | 字串 | 對 | |
| 用戶端識別碼 | 字串 | Microsoft Entra ID 應用程式的用戶端識別碼 | 對 |
| 用戶端憑證密碼 | 客戶憑證 | 此應用程式允許的用戶端憑證密碼 | 對 |
使用 Microsoft Entra ID 登入
驗證 ID:EntraOAuth
適用:僅限生產
使用 Microsoft Entra ID 登入
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
服務主體帳戶驗證
身份驗證 ID:OauthSP
適用:所有地區
使用 Microsoft Entra ID 應用程式進行服務主體驗證
這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 租戶 | 字串 | 對 | |
| 用戶端識別碼 | 字串 | Microsoft Entra ID 應用程式的用戶端識別碼 | 對 |
| 客戶端密碼 | securestring | 對 |
預設值 [已棄用]
適用:所有地區
此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 300 | 60 秒 |
動作
| 列出 Git 存放庫 |
擷取專案中的 Git 存放庫清單。 |
| 列出反覆項目 |
擷取專案的疊代清單。 |
| 列出專案 |
擷取組織中的專案清單。 |
| 列出工作專案類型 |
擷取指定 Azure DevOps 專案中可存取的工作專案類型清單。 |
| 列出工作項目 |
傳回工作專案清單。 |
| 列出根層級查詢 |
擷取專案中根層級工作專案查詢的清單。 |
| 列出發行定義 |
擷取與專案相關聯的發行定義清單。 |
| 列出管線執行 |
取得特定管線的前 10000 次執行 |
| 列出管道 |
擷取專案中的管線清單。 |
| 列出組織 |
擷取使用者所屬的組織清單。 |
| 列出資料夾內的查詢 |
擷取指定專案資料夾內的工作專案查詢清單。 |
| 取得工作專案子系 |
取得單一工作專案的子系清單 (大小上限 1000)。 |
| 取得工作專案詳細資料 |
取得單一工作專案的詳細數據。 |
| 取得查詢結果 |
擷取工作專案查詢的結果。 |
| 取得查詢結果 [已淘汰] |
此動作已被取代。 請改用 [取得查詢結果 ]。
|
|
將 HTTP 要求傳送至 Azure Dev |
建構要叫用的 Azure DevOps REST API 要求。 請參閱下列連結,以取得所有可用的端點: https://docs.microsoft.com/rest/api/azure/devops |
| 將新組建排入佇列 |
根據現有的組建定義建立組建,並將它新增至組建佇列。 |
| 建立工作項目 |
使用提供的屬性建立新的工作專案。 |
| 建立新版本 |
根據現有的發行定義建立發行。 |
| 更新工作項目 |
依識別碼更新現有的工作專案。 |
| 獲取用戶個人資料 |
取得使用者配置檔。 |
列出 Git 存放庫
擷取專案中的 Git 存放庫清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
傳回
VSTS 模型清單。
列出反覆項目
擷取專案的疊代清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱
|
team | True | string |
專案內小組的名稱。 |
傳回
VSTS 模型清單。
列出專案
擷取組織中的專案清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
傳回
VSTS 模型清單。
列出工作專案類型
擷取指定 Azure DevOps 專案中可存取的工作專案類型清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
傳回
VSTS 模型清單。
列出工作項目
傳回工作專案清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
工作專案識別碼
|
workItemIds | True | string |
要求工作專案識別碼的逗號分隔清單。 |
|
工作項目類型
|
workItemType | string |
要產生結構描述的工作專案類型。 |
傳回
列出根層級查詢
擷取專案中根層級工作專案查詢的清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
傳回
VSTS 模型清單。
列出發行定義
擷取與專案相關聯的發行定義清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
傳回
VSTS 模型清單。
列出管線執行
取得特定管線的前 10000 次執行
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
管線識別碼
|
pipelineId | True | integer |
管線識別碼 |
傳回
- 身體
- Run
列出管道
擷取專案中的管線清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
傳回
- 身體
- Pipeline
列出組織
列出資料夾內的查詢
擷取指定專案資料夾內的工作專案查詢清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
資料夾路徑
|
folderPath | True | string |
要在其下尋找查詢的資料夾路徑。 |
傳回
VSTS 模型清單。
取得工作專案子系
取得單一工作專案的子系清單 (大小上限 1000)。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
工作項目識別碼
|
id | True | string |
要取得子系的工作專案的唯一識別碼。 |
|
子項工作項目類型
|
workItemType | string |
子工作專案的類型 |
傳回
取得工作專案詳細資料
取得單一工作專案的詳細數據。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
工作項目類型
|
typeName | True | string |
工作專案的工作專案類型。 |
|
工作項目識別碼
|
id | True | string |
要取得詳細資料的工作專案的唯一識別碼。工作專案必須是 '工作專案類型' 中指定的類型。 |
傳回
取得查詢結果
擷取工作專案查詢的結果。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
查詢標識碼
|
queryId | True | string |
要執行之儲存查詢的識別碼。 |
|
要傳回的工作專案數目
|
workItemsCount | integer |
要擷取的工作專案計數上限 (1 - 20000) |
|
|
如果查詢結果變更,則失敗
|
throwIfQueryChanged | boolean |
如果查詢結果在流程執行期間變更,則流程執行應該失敗,以避免不一致。 |
傳回
取得查詢結果 [已淘汰]
此動作已被取代。 請改用 [取得查詢結果 ]。
擷取工作專案查詢的結果。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
查詢標識碼
|
queryId | True | string |
要執行之儲存查詢的識別碼。 |
傳回
VSTS 模型清單。
將 HTTP 要求傳送至 Azure DevOps
建構要叫用的 Azure DevOps REST API 要求。 請參閱下列連結,以取得所有可用的端點: https://docs.microsoft.com/rest/api/azure/devops
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
方法
|
Method | True | string |
HTTP 方法。 |
|
相對 URI
|
Uri | True | string |
相對 URI。 範例:{project}/{team}/_apis/wit/templates?api-version=5.0-preview.1。 |
|
Headers
|
Headers | object |
要求標頭。 |
|
|
身體
|
Body | string |
請求內容。 可以是 JSON 物件或編碼為 Base64 字串的二進位資料。 |
|
|
主體為 Base64
|
IsBase64 | boolean |
如果要求內容編碼為 Base64 字串,則必須為 true。 |
傳回
- response
- ObjectWithoutType
將新組建排入佇列
根據現有的組建定義建立組建,並將它新增至組建佇列。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
組建定義識別碼
|
buildDefId | True | string |
要使用的組建定義識別碼。 |
|
來源分支
|
sourceBranch | string |
組建的來源分支。 |
|
|
參數
|
parameters | string |
選擇性建置參數的 JSON 字典。 |
傳回
建置結果
- 身體
- BuildResult
建立工作項目
使用提供的屬性建立新的工作專案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
工作項目類型
|
type | True | string |
此工作專案的類型 |
|
傳回所有欄位
|
shouldReturnAllFields | boolean |
將值設定為 'No' 時,只會傳回工作專案識別碼。 如果值為「是」,則會傳回已建立專案的所有欄位以及識別碼。 預設值為「是」 |
|
|
工作專案詳細資料
|
workItem | True | dynamic |
要包含在新工作專案中的資訊 |
傳回
建立新版本
根據現有的發行定義建立發行。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
發行定義標識符
|
releaseDefId | True | string |
要使用的發行定義識別碼。 |
|
Description
|
Description | string |
發行開始中繼資料的說明。 |
|
|
是草稿
|
IsDraft | boolean |
指定發行是否為草稿。 |
|
|
原因
|
Reason | string |
發行開始中繼資料的原因。 |
|
|
名稱
|
Name | True | string |
組態變數的名稱。 |
|
價值觀
|
Value | string |
組態變數的值。 |
傳回
釋放
- 身體
- Release
更新工作項目
依識別碼更新現有的工作專案。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
工作項目識別碼
|
id | True | string |
要更新之工作專案的唯一識別碼。 |
|
專案名稱
|
project | string |
指定組織內的專案名稱。 |
|
|
工作項目類型
|
type | string |
要產生結構描述的工作專案類型。 |
|
|
工作專案詳細資料
|
workItem | True | dynamic |
工作專案的詳細資料。 |
傳回
獲取用戶個人資料
取得使用者配置檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
設定檔ID
|
id | True | string |
相同組織內設定檔的 ID,或「我」以取得目前已驗證使用者的設定檔。 |
傳回
Profile
- 身體
- Profile
觸發程序
| 建立工作專案時 |
建立符合所提供準則的工作專案時觸發流程。 |
| 建立工作專案時 [已淘汰] |
此動作已被取代。 請改用建立 工作專案時 。
|
| 建立提取要求時 (Git) |
建立符合所提供準則的提取要求時觸發流程。 |
| 指派工作專案時 |
當符合所提供準則的工作專案指派給指定的使用者時,會觸發流程。 |
| 指派工作專案時 [已取代] |
此動作已被取代。 請改用指派 工作專案時 。
|
| 推送程式碼時 (Git) |
當程式碼推送至 Git 存放庫時觸發流程。 |
| 更新工作專案時 |
當更新符合所提供準則的工作專案時,觸發流程。 |
| 更新工作專案時 [已取代] |
此動作已被取代。 請改用 [更新 工作專案時 ]。
|
| 當工作專案關閉時 [已淘汰] |
此動作已被取代。 請改用 When a work item is close 。
|
| 當工作項目關閉時 |
關閉符合所提供準則的工作專案時觸發流程。 |
| 當建置完成時 |
在建置完成時觸發流程。 |
| 當提取要求關閉時 (Git) |
當符合所提供準則的提取要求關閉時觸發流程。 |
| 簽入程式代碼時 (TFVC) |
當程式碼簽入 Team Foundation 版本控制專案時觸發流程。 |
建立工作專案時
建立符合所提供準則的工作專案時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱 (若要挑選 [指派給])
|
team | string |
要從中選取受指派人的小組名稱。 |
|
|
指派至
|
wiql__System_AssignedTo | string |
目前擁有工作專案的小組成員名稱。 |
|
|
類型
|
wiql__System_WorkItemType | string |
工作項目類型的名稱。 |
|
|
區域路徑
|
wiql__System_AreaPath | string |
工作項目所在的產品特性或團隊區域。 |
|
|
區域路徑比較
|
areaPathComparison | string |
比較區域路徑欄位時要使用的規則。 |
|
|
迭代路徑
|
wiql__System_IterationPath | string |
工作專案所在的具名短期衝刺或時段。 |
|
|
疊代路徑比較
|
iterationPathComparison | string |
比較疊代路徑欄位時要使用的規則。 |
|
|
Priority
|
wiql__Microsoft_VSTS_Common_Priority | string |
與業務相關的 Bug、問題、工作或測試案例的主觀評等。 |
|
|
作者
|
wiql__System_CreatedBy | string |
建立工作專案的小組成員名稱。 |
傳回
建立工作專案時 [已淘汰]
此動作已被取代。 請改用建立 工作專案時 。
建立符合所提供準則的工作專案時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱 (若要挑選 [指派給])
|
team | string |
要從中選取受指派人的小組名稱。 |
|
|
指派至
|
wiql__System_AssignedTo | string |
目前擁有工作專案的小組成員名稱。 |
|
|
類型
|
wiql__System_WorkItemType | string |
工作項目類型的名稱。 |
|
|
區域路徑
|
wiql__System_AreaPath | string |
工作項目所在的產品特性或團隊區域。 |
|
|
區域路徑比較
|
areaPathComparison | string |
比較區域路徑欄位時要使用的規則。 |
|
|
迭代路徑
|
wiql__System_IterationPath | string |
工作專案所在的具名短期衝刺或時段。 |
|
|
疊代路徑比較
|
iterationPathComparison | string |
比較疊代路徑欄位時要使用的規則。 |
|
|
Priority
|
wiql__Microsoft_VSTS_Common_Priority | string |
與業務相關的 Bug、問題、工作或測試案例的主觀評等。 |
|
|
團隊項目
|
wiql__System_TeamProject | string |
此工作專案所屬的小組專案。 |
|
|
作者
|
wiql__System_CreatedBy | string |
建立工作專案的小組成員名稱。 |
傳回
建立提取要求時 (Git)
建立符合所提供準則的提取要求時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
存放庫名稱
|
repository | True | string |
指定專案內儲存庫的名稱。 |
|
來源參考名稱
|
sourceRefName | string |
Git 參考的名稱,例如分支或標籤。 |
|
|
目標參考名稱
|
targetRefName | string |
Git 參考的名稱,例如分支或標籤。 |
傳回
VSTS 模型清單。
指派工作專案時
當符合所提供準則的工作專案指派給指定的使用者時,會觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱 (若要挑選 [指派給])
|
team | True | string |
要從中選取成員的小組名稱。 |
|
指派至
|
wiql__System_AssignedTo | True | string |
目前擁有工作專案的小組成員名稱。 |
|
類型
|
wiql__System_WorkItemType | string |
工作項目類型的名稱。 |
|
|
區域路徑
|
wiql__System_AreaPath | string |
工作項目所在的產品特性或團隊區域。 |
|
|
區域路徑比較
|
areaPathComparison | string |
比較區域路徑欄位時要使用的規則。 |
|
|
迭代路徑
|
wiql__System_IterationPath | string |
工作專案所在的具名短期衝刺或時段。 |
|
|
疊代路徑比較
|
iterationPathComparison | string |
比較疊代路徑欄位時要使用的規則。 |
|
|
Priority
|
wiql__Microsoft_VSTS_Common_Priority | string |
與業務相關的 Bug、問題、工作或測試案例的主觀評等。 |
|
|
作者
|
wiql__System_CreatedBy | string |
建立工作專案的小組成員名稱。 |
傳回
指派工作專案時 [已取代]
此動作已被取代。 請改用指派 工作專案時 。
當符合所提供準則的工作專案指派給指定的使用者時,會觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
指派至
|
wiql__System_AssignedTo | True | string |
目前擁有工作專案的小組成員名稱。 |
|
小組名稱 (若要挑選 [指派給])
|
team | string |
要從中選取成員的小組名稱。 |
|
|
類型
|
wiql__System_WorkItemType | string |
工作項目類型的名稱。 |
|
|
區域路徑
|
wiql__System_AreaPath | string |
工作項目所在的產品特性或團隊區域。 |
|
|
區域路徑比較
|
areaPathComparison | string |
比較區域路徑欄位時要使用的規則。 |
|
|
迭代路徑
|
wiql__System_IterationPath | string |
工作專案所在的具名短期衝刺或時段。 |
|
|
疊代路徑比較
|
iterationPathComparison | string |
比較疊代路徑欄位時要使用的規則。 |
|
|
Priority
|
wiql__Microsoft_VSTS_Common_Priority | string |
與業務相關的 Bug、問題、工作或測試案例的主觀評等。 |
|
|
團隊項目
|
wiql__System_TeamProject | string |
此工作專案所屬的小組專案。 |
|
|
作者
|
wiql__System_CreatedBy | string |
建立工作專案的小組成員名稱。 |
傳回
推送程式碼時 (Git)
當程式碼推送至 Git 存放庫時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
存放庫名稱
|
repository | True | string |
指定專案內儲存庫的名稱。 |
|
參考名稱
|
refName | string |
Git 參考的名稱,例如分支或標籤。 |
傳回
VSTS 模型清單。
更新工作專案時
當更新符合所提供準則的工作專案時,觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱 (若要挑選 [指派給])
|
team | string |
要從中選取受指派人的小組名稱。 |
|
|
指派至
|
wiql__System_AssignedTo | string |
目前擁有工作專案的小組成員名稱。 |
|
|
類型
|
wiql__System_WorkItemType | string |
工作項目類型的名稱。 |
|
|
區域路徑
|
wiql__System_AreaPath | string |
工作項目所在的產品特性或團隊區域。 |
|
|
區域路徑比較
|
areaPathComparison | string |
比較區域路徑欄位時要使用的規則。 |
|
|
迭代路徑
|
wiql__System_IterationPath | string |
工作專案所在的具名短期衝刺或時段。 |
|
|
疊代路徑比較
|
iterationPathComparison | string |
比較疊代路徑欄位時要使用的規則。 |
|
|
Priority
|
wiql__Microsoft_VSTS_Common_Priority | string |
與業務相關的 Bug、問題、工作或測試案例的主觀評等。 |
|
|
作者
|
wiql__System_CreatedBy | string |
建立工作專案的小組成員名稱。 |
傳回
更新工作專案時 [已取代]
此動作已被取代。 請改用 [更新 工作專案時 ]。
當更新符合所提供準則的工作專案時,觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱 (若要挑選 [指派給])
|
team | string |
要從中選取受指派人的小組名稱。 |
|
|
指派至
|
wiql__System_AssignedTo | string |
目前擁有工作專案的小組成員名稱。 |
|
|
類型
|
wiql__System_WorkItemType | string |
工作項目類型的名稱。 |
|
|
區域路徑
|
wiql__System_AreaPath | string |
工作項目所在的產品特性或團隊區域。 |
|
|
區域路徑比較
|
areaPathComparison | string |
比較區域路徑欄位時要使用的規則。 |
|
|
迭代路徑
|
wiql__System_IterationPath | string |
工作專案所在的具名短期衝刺或時段。 |
|
|
疊代路徑比較
|
iterationPathComparison | string |
比較疊代路徑欄位時要使用的規則。 |
|
|
Priority
|
wiql__Microsoft_VSTS_Common_Priority | string |
與業務相關的 Bug、問題、工作或測試案例的主觀評等。 |
|
|
團隊項目
|
wiql__System_TeamProject | string |
此工作專案所屬的小組專案。 |
|
|
作者
|
wiql__System_CreatedBy | string |
建立工作專案的小組成員名稱。 |
傳回
當工作專案關閉時 [已淘汰]
此動作已被取代。 請改用 When a work item is close 。
關閉符合所提供準則的工作專案時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱 (若要挑選 [指派給])
|
team | string |
要從中選取受指派人的小組名稱。 |
|
|
指派至
|
wiql__System_AssignedTo | string |
目前擁有工作專案的小組成員名稱。 |
|
|
類型
|
wiql__System_WorkItemType | string |
工作項目類型的名稱。 |
|
|
區域路徑
|
wiql__System_AreaPath | string |
工作項目所在的產品特性或團隊區域。 |
|
|
區域路徑比較
|
areaPathComparison | string |
比較區域路徑欄位時要使用的規則。 |
|
|
迭代路徑
|
wiql__System_IterationPath | string |
工作專案所在的具名短期衝刺或時段。 |
|
|
疊代路徑比較
|
iterationPathComparison | string |
比較疊代路徑欄位時要使用的規則。 |
|
|
Priority
|
wiql__Microsoft_VSTS_Common_Priority | string |
與業務相關的 Bug、問題、工作或測試案例的主觀評等。 |
|
|
團隊項目
|
wiql__System_TeamProject | string |
此工作專案所屬的小組專案。 |
|
|
作者
|
wiql__System_CreatedBy | string |
建立工作專案的小組成員名稱。 |
傳回
當工作項目關閉時
關閉符合所提供準則的工作專案時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱 (若要挑選 [指派給])
|
team | string |
要從中選取受指派人的小組名稱。 |
|
|
指派至
|
wiql__System_AssignedTo | string |
目前擁有工作專案的小組成員名稱。 |
|
|
類型
|
wiql__System_WorkItemType | string |
工作項目類型的名稱。 |
|
|
關閉狀態
|
closedState | string |
以逗點分隔的 [狀態] 欄位值清單,指出如何關閉工作專案 (完成、已關閉、已完成、非作用中)。 |
|
|
區域路徑
|
wiql__System_AreaPath | string |
工作項目所在的產品特性或團隊區域。 |
|
|
區域路徑比較
|
areaPathComparison | string |
比較區域路徑欄位時要使用的規則。 |
|
|
迭代路徑
|
wiql__System_IterationPath | string |
工作專案所在的具名短期衝刺或時段。 |
|
|
疊代路徑比較
|
iterationPathComparison | string |
比較疊代路徑欄位時要使用的規則。 |
|
|
Priority
|
wiql__Microsoft_VSTS_Common_Priority | string |
與業務相關的 Bug、問題、工作或測試案例的主觀評等。 |
|
|
作者
|
wiql__System_CreatedBy | string |
建立工作專案的小組成員名稱。 |
傳回
當建置完成時
在建置完成時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
依結果篩選
|
resultFilter | string |
指示要觸發哪個建置結果的選項。 有效選項包括 ''、'succeeded'、'partiallySucceeded'、'failed' 或 'canceled'。 |
|
|
依定義識別碼篩選
|
definitions | string |
指出要觸發的組建定義識別碼的選項。 |
傳回
VSTS 模型清單。
當提取要求關閉時 (Git)
當符合所提供準則的提取要求關閉時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
存放庫名稱
|
repository | True | string |
指定專案內儲存庫的名稱。 |
|
來源參考名稱
|
sourceRefName | string |
Git 參考的名稱,例如分支或標籤。 |
|
|
目標參考名稱
|
targetRefName | string |
Git 參考的名稱,例如分支或標籤。 |
傳回
VSTS 模型清單。
簽入程式代碼時 (TFVC)
當程式碼簽入 Team Foundation 版本控制專案時觸發流程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
組織名稱
|
account | True | string |
組織的名稱。 這可以在實例 URL 中找到,即 {Organization}.visualstudio.com。 組織應啟用「透過 OAuth 存取第三方應用程式」,以防止作業發生錯誤。 |
|
專案名稱
|
project | True | string |
指定組織內的專案名稱。 |
|
小組名稱
|
team | string |
要選取作者的團隊名稱。 |
|
|
小組成員
|
author | string |
撰寫簽入的小組成員的唯一名稱。 |
傳回
VSTS 模型清單。
定義
VstsList[帳戶]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of Account |
VSTS 模型 |
Account
Account
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
帳戶 ID
|
accountId | string |
帳戶的 ID。 |
|
帳戶 URI
|
accountUri | string |
帳戶的 URI。 |
|
客戶名稱
|
accountName | string |
帳戶的名稱。 |
|
帳戶擁有者
|
accountOwner | string |
帳戶的集合擁有者。 |
|
組織名稱
|
organizationName | string |
與帳戶相對應的組織名稱。 |
|
帳戶類型
|
accountType | string |
帳戶的類型。 |
Profile
Profile
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
顯示名稱
|
displayName | string |
使用者的顯示名稱 |
|
識別碼
|
id | string |
設定檔的唯一識別碼。 |
|
publicAlias
|
publicAlias | string |
公共別名。 |
|
電子郵件地址
|
emailAddress | string |
帳戶的電子郵件地址。 |
|
時間戳記
|
timeStamp | date-time |
上次變更此設定檔的時間。 |
|
修訂
|
revision | integer |
任何屬性的修訂編號上限。 |
|
核心修訂
|
coreRevision | integer |
核心修訂 |
VstsList[TeamSettingsIteration]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of TeamSettingsIteration |
VSTS 模型 |
TeamSettings反覆專案
工作(敏捷)迭代
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Attributes
|
Attributes | TeamIterationAttributes |
團隊疊代屬性 |
|
身份識別碼
|
Id | string |
資源的識別碼。 |
|
名稱
|
Name | string |
資源的名稱。 |
|
路徑
|
Path | string |
疊代的相對路徑。 |
|
Links
|
_links | object |
與資源相關的連結集合。 |
|
URL
|
Url | string |
資源的完整 HTTP 連結。 |
TeamIteration屬性
團隊疊代屬性
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
完成日期
|
FinishDate | date-time |
完成日期小組疊代屬性。 |
|
開始日期
|
StartDate | date-time |
開始日期小組反覆專案屬性。 |
Links
Links
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
web
|
web | WebLinks |
網頁連結 |
網絡鏈接
網頁連結
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
HTML連結
|
href | string |
組建詳細資料的 Web URL |
建置結果
建置結果
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
組建標識符
|
id | integer |
組建的唯一識別碼。 |
|
組建編號
|
buildNumber | string |
組建編號。 |
|
來源分支
|
sourceBranch | string |
組建所使用的原始檔控制分支。 |
|
來源版本
|
sourceVersion | string |
組建使用的原始檔控制版本。 |
|
地位
|
status | string |
組建的狀態。 |
|
Priority
|
priority | string |
建置的優先順序。 |
|
排隊時間
|
queueTime | date-time |
組建佇列的時間。 |
|
開始時間
|
startTime | date-time |
建置開始的時間。 |
|
完成時間
|
finishTime | date-time |
建置完成的時間。 |
|
原因
|
reason | string |
構建的原因。 |
|
Result
|
result | string |
建置的結果。 |
|
requestedFor
|
requestedFor | BuildRequestUser |
建置要求使用者 |
|
參數
|
parameters | string |
傳遞至組建的參數 (如果有的話)。 |
|
定義
|
definition | BuildResultDefinition |
建置結果定義 |
|
_links
|
_links | Links |
Links |
建置請求使用者
建置要求使用者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
請求對象
|
uniqueName | string |
要求組建之使用者的唯一名稱。 |
BuildResult定義
建置結果定義
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
組建定義識別碼
|
id | integer |
組建定義的識別碼。 |
|
建置定義名稱
|
name | string |
組建定義的名稱。 |
VstsList[建置結果]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of BuildResult |
VSTS 模型 |
VstsList[Git存放庫]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of GitRepository |
VSTS 模型 |
Git儲存庫
Git 儲存庫
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
存放庫識別碼
|
id | string |
存放庫的唯一 ID。 |
|
存放庫名稱
|
name | string |
存放庫的名稱。 |
|
存放庫瀏覽器 URL
|
url | string |
URL 是存放庫的 API 端點。 |
|
儲存庫遠端 URL
|
remoteUrl | string |
git 可透過此存放庫同步的 URL。 |
VstsList[Git推送]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of GitPush |
VSTS 模型 |
GitPush 的
Git 推送
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
存放庫
|
repository | GitRepository |
Git 儲存庫 |
|
推送者
|
pushedBy | GitPushUser |
Git 推送使用者 |
|
參考更新
|
refUpdates | array of GitRefUpdate |
作為此推送的一部分更新的參考。 |
|
推播 ID
|
pushId | integer |
推送的唯一 ID。 |
|
Date
|
date | date-time |
推播的建立日期。 |
GitPushUser
Git 推送使用者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
推送器 ID
|
id | string |
建立推播之使用者的唯一識別碼。 |
|
推桿名稱
|
displayName | string |
建立推播的使用者名稱。 |
|
推桿唯一名稱
|
uniqueName | string |
建立推播之使用者的唯一名稱。 |
|
推送器影像網址
|
imageUrl | string |
此使用者影像的 URL。 |
VstsList[GitPullRequest]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of GitPullRequest |
VSTS 模型 |
GitPull請求
Git 提取請求
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
存放庫
|
repository | GitRepository |
Git 儲存庫 |
|
提取要求識別碼
|
pullRequestId | integer |
提取要求的唯一識別碼。 |
|
由...創建
|
createdBy | PullRequestCreatedBy |
提取請求建立者 |
|
建立日期
|
creationDate | date-time |
提取要求的建立日期 |
|
截止日期
|
closedDate | date-time |
提取請求關閉的日期 (完成、放棄或外部合併) |
|
Title
|
title | string |
提取要求的標題 |
|
Description
|
description | string |
提取請求的描述 |
|
來源參考名稱
|
sourceRefName | string |
提取要求的來源分支名稱 |
|
目標參考名稱
|
targetRefName | string |
提取要求的目標分支名稱 |
|
是草稿
|
isDraft | boolean |
草稿/WIP 提取請求 |
|
檢閱者
|
reviewers | array of PullRequestReviewer |
此檢閱者所貢獻的群組或小組。 |
|
審閱者名單
|
reviewerList | string |
以分號分隔的檢閱者唯一名稱清單,這些名稱是有效的電子郵件地址 |
|
必要的審核者清單
|
requiredReviewerList | string |
以分號分隔的必要檢閱者唯一名稱清單,這些名稱是有效的電子郵件地址 |
|
認可
|
commits | array of GitCommitRef |
提取請求中包含的認可。 |
|
完成選項
|
completionOptions | PullRequestCompletionOptions |
提取要求完成選項 |
|
合併選項
|
mergeOptions | PullRequestMergeOptions |
提取請求合併選項 |
|
合併失敗訊息
|
mergeFailureMessage | string |
如果設定,提取要求合併會因為這個原因而失敗。 |
|
closedBy
|
closedBy | PullRequestClosedBy |
拉取要求關閉者 |
|
autoCompleteSetBy
|
autoCompleteSetBy | PullRequestAutoCompleteSetBy |
提取請求自動完成集 |
|
網址
|
url | string |
提取要求的 URL。 |
|
遠端網址
|
remoteUrl | string |
提取要求的遠端 URL。 |
|
成品識別碼
|
artifactId | string |
唯一識別此提取請求的字串。 |
|
合併標識符
|
mergeId | string |
提取要求的合併識別碼。 |
|
程式碼檢閱標識符
|
codeReviewId | integer |
提取要求的程式碼檢閱識別碼。 |
|
完成佇列時間
|
completionQueueTime | string |
提取要求進入佇列以完成的最近日期。 |
|
支援疊代
|
supportsIterations | boolean |
如果為true,則此提取請求支援多次反覆專案。 |
PullRequestCreatedBy
提取請求建立者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
依顯示名稱建立
|
displayName | string |
提取要求建立者的顯示名稱。 |
|
依唯一名稱建立
|
uniqueName | string |
提取要求建立者的唯一名稱。 |
|
建立者 Id
|
id | string |
提取要求建立者的識別碼。 |
|
由圖像 URL 創建
|
imageUrl | string |
提取要求建立者影像的 URL。 |
|
創建者網址
|
url | string |
提取要求建立者的 URL。 |
PullRequestClosedBy
拉取要求關閉者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
關閉方式顯示名稱
|
displayName | string |
提取要求的顯示名稱。 |
|
以唯一名稱關閉
|
uniqueName | string |
提取要求關閉的唯一名稱。 |
|
關閉者 Id
|
id | string |
提取要求的識別碼較接近。 |
|
由圖像網址關閉
|
imageUrl | string |
提取要求影像的 url closer。 |
|
關閉網址
|
url | string |
提取要求的 url closer。 |
PullRequestAutoCompleteSetBy
提取請求自動完成集
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
按顯示名稱自動完成集
|
displayName | string |
啟用自動完成之使用者的顯示名稱。 |
|
按唯一名稱自動完成集
|
uniqueName | string |
啟用自動完成之使用者的唯一名稱。 |
|
自動完成 (依 ID) 集
|
id | string |
啟用自動完成的使用者識別碼。 |
|
自動完成依影像 URL 設定
|
imageUrl | string |
啟用自動完成之使用者影像的 URL。 |
|
按 URL 自動完成設置
|
url | string |
啟用自動完成的使用者的 URL。 |
PullRequestReviewer
提取要求檢閱者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
檢閱者顯示名稱
|
displayName | string |
提取要求檢閱者的顯示名稱。 |
|
檢閱者唯一名稱
|
uniqueName | string |
提取要求檢閱者的唯一名稱。 |
|
檢閱者識別碼
|
id | string |
提取要求檢閱者的識別碼。 |
|
審稿人網址
|
url | string |
提取要求檢閱者的 URL。 |
|
已經衰落
|
hasDeclined | boolean |
指出此檢閱者是否已拒絕檢閱此提取要求。 |
|
已標記
|
isFlagged | boolean |
指出此檢閱者是否標幟為注意此提取要求。 |
|
是必要的
|
isRequired | boolean |
指出此提取要求是否為必要檢閱者。 |
|
投票
|
vote | integer |
對拉取請求進行投票:approved(10)、approved with suggestions(5)、no vote(0)、waiting for author(-5)、rejected(-10)。 |
|
投票贊成
|
votedFor | array of PullRequestReviewer |
此檢閱者所貢獻的群組或小組。 |
PullRequestMergeOptions
提取請求合併選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
沒有快轉
|
noFastForward | string |
雙父、不快轉合併。 來源分支保持不變。 此為預設行為。 |
|
重新設定基底
|
rebase | string |
將來源分支重新設定在目標分支 HEAD 認可之上,並快轉目標分支。 |
|
變基合併
|
rebaseMerge | string |
在目標分支 HEAD 認可之上重新設定來源分支的基底,並建立雙父項、無快轉合併。 |
|
南瓜
|
squash | string |
將提取要求中的所有變更放入單一父系認可中。 |
PullRequestMerge策略
提取請求合併策略
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
衝突作者身份認可
|
conflictAuthorshipCommits | boolean |
如果為true,則合併期間應用的衝突解決方案將放入單獨的提交中,以保留作者資訊以供git 責備。 |
|
偵測重新命名誤報
|
detectRenameFalsePositives | boolean |
如果為true,則會偵測重新命名誤判。 |
|
停用重新命名
|
disableRenames | boolean |
如果為true,則在合併期間不會執行重新命名偵測。 |
PullRequestCompletionOptions
提取要求完成選項
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
自動完成忽略組態標識碼
|
autoCompleteIgnoreConfigIds | array of integer |
自動完成不應等候的任何原則組態識別碼清單 |
|
略過政策
|
bypassPolicy | boolean |
如果為 true,則會在提取要求完成時明確略過原則。 |
|
繞過原因
|
bypassReason | string |
如果略過原則,此原因會儲存為使用略過的原因。 |
|
刪除來源分支
|
deleteSourceBranch | boolean |
如果為 true,提取要求的來源分支將會在完成之後刪除。 |
|
合併認可訊息
|
mergeCommitMessage | string |
如果設定,這將會當做合併認可的認可訊息使用。 |
|
合併策略
|
mergeStrategy | PullRequestMergeStrategy |
提取請求合併策略 |
|
壁球合併
|
squashMerge | boolean |
如果未設定 MergeStrategy,如果此旗標為 false,合併策略將會是 no-fast-forward,如果為 true 則為 squash。 |
|
轉換工作專案
|
transitionWorkItems | boolean |
如果為true,我們會嘗試將連結至提取要求的任何工作專案轉換成下一個邏輯狀態 (,亦即作用中 -> 已解決) 。 |
提交GitUserDate
提交 Git 使用者日期
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
認可使用者日期
|
date | string |
Git 作業的日期。 |
|
認可使用者電子郵件
|
string |
執行 Git 作業之使用者的電子郵件位址。 |
|
|
提交映像 URL
|
imageUrl | string |
用戶的虛擬人偶 URL。 |
|
認可使用者名稱
|
name | string |
執行 Git 作業的用戶名稱。 |
GitCommitRef
Git 提交參考
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作者
|
author | CommitGitUserDate |
提交 Git 使用者日期 |
|
提交註解
|
comment | string |
認可的批註或訊息。 |
|
提交註解已截斷
|
commentTruncated | string |
指出批註是否從完整的 Git 認可批注訊息中截斷。 |
|
認可標識碼
|
commitId | string |
認可的標識碼。 |
|
提交者
|
committer | CommitGitUserDate |
提交 Git 使用者日期 |
|
父母
|
parents | array of string |
這個認可之父認可標識碼的列舉。 |
|
認可遠端 URL
|
remoteUrl | string |
認可的遠端 URL 路徑。 |
|
認可網址
|
url | string |
此資源的 REST URL。 |
GitRef更新
Git 參考更新
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
參考名稱
|
name | string |
已更新的 Git 參考名稱。 |
|
存放庫識別碼
|
repositoryId | string |
存放庫的唯一 ID。 |
|
舊的認可標識碼
|
oldObjectId | string |
此 Ref 在更新之前指向的先前提交的 ID。 |
|
新的認可識別碼
|
newObjectId | string |
此 Ref 在更新之前指向的新認可的 ID。 |
VstsList[專案]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of Project |
VSTS 模型 |
專案
專案
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
專案編號
|
id | string |
專案的唯一識別碼。 |
|
專案名稱
|
name | string |
項目的名稱。 |
|
專案網址
|
url | string |
專案的 API URL。 |
VstsList[釋牌定義]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of ReleaseDefinition |
VSTS 模型 |
釋出定義
發行定義
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
評論
|
Comment | string |
發行定義的註解。 |
|
創建日期
|
CreatedOn | date-time |
建立發行定義的日期。 |
|
Description
|
Description | string |
發行定義的說明。 |
|
身份識別碼
|
Id | integer |
發行定義的唯一識別碼。 |
|
ModifiedBy
|
ModifiedBy | IdentityRef |
身份參考 |
|
修改時間
|
ModifiedOn | date-time |
修改發行定義的日期。 |
|
名稱
|
Name | string |
發行定義的名稱。 |
|
路徑
|
Path | string |
發行定義的路徑。 |
|
發行名稱格式
|
ReleaseNameFormat | string |
發行定義的發行名稱格式。 |
|
Revision
|
Revision | integer |
發行定義的修訂編號。 |
|
來源
|
Source | string |
發行定義的來源。 |
|
Tags
|
Tags | array of string |
發行定義的標籤清單。 |
|
URL
|
Url | string |
存取發行定義的 URL。 |
身份參考
身份參考
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
目錄別名
|
DirectoryAlias | string |
身分識別參照的目錄別名。 |
|
顯示名稱
|
DisplayName | string |
身分識別參考的顯示名稱。 |
|
唯一名稱
|
UniqueName | string |
身分參照的唯一名稱。 |
|
URL
|
Url | string |
身分識別參考的 URL。 |
|
身份識別碼
|
Id | string |
身分識別參照的 ID。 |
ReleaseDefinitionShallowReference
發行定義淺層參考
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
身份識別碼
|
Id | integer |
發行定義的唯一識別碼。 |
|
名稱
|
Name | string |
發行定義的名稱。 |
|
URL
|
Url | string |
用於存取發行定義的 REST API URL。 |
物體
物件無類型
釋放
釋放
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
評論
|
Comment | string |
發布的評論。 |
|
CreatedBy
|
CreatedBy | IdentityRef |
身份參考 |
|
創建日期
|
CreatedOn | date-time |
建立發行的日期。 |
|
Description
|
Description | string |
版本的說明。 |
|
身份識別碼
|
Id | integer |
版本的唯一識別碼。 |
|
永遠保留
|
KeepForever | boolean |
是否要從保留原則中排除發行。 |
|
記錄容器 URL
|
LogsContainerUrl | string |
此版本的記錄容器 URL。 |
|
ModifiedBy
|
ModifiedBy | IdentityRef |
身份參考 |
|
修改時間
|
ModifiedOn | date-time |
修改版本的日期。 |
|
名稱
|
Name | string |
發行的名稱。 |
|
原因
|
Reason | string |
發布的原因。 |
|
釋出定義
|
ReleaseDefinition | ReleaseDefinitionShallowReference |
發行定義淺層參考 |
|
地位
|
Status | string |
發行的狀態。 |
|
URL
|
Url | string |
發行的 URL。 |
VstsList[Tfvc變更集]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of TfvcChangeset |
VSTS 模型 |
Tfvc變更集
Team Foundation 版本控制變更集
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
變更集識別碼
|
changesetId | integer |
變更集的唯一識別碼。 |
|
作者
|
author | ChangesetAuthor |
變更集作者 |
|
checkedInBy
|
checkedInBy | ChangesetCheckedInBy |
簽入的變更集 |
|
建立日期
|
createdDate | date-time |
建立變更集的日期時間。 |
|
評論
|
comment | string |
描述變更集的註解。 |
變更集作者
變更集作者
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作者姓名
|
displayName | string |
建立變更集的使用者名稱。 |
|
作者唯一名稱
|
uniqueName | string |
建立變更集之使用者的唯一名稱。 |
變更集CheckedInBy
簽入的變更集
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
依名稱簽入
|
displayName | string |
簽入變更集的使用者名稱。 |
|
依唯一名稱簽入
|
uniqueName | string |
建立變更集之使用者的唯一名稱。 |
VstsList[工作專案類型]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of WorkItemType |
VSTS 模型。 |
WorkItemType
工作項目類型
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Description
|
Description | string |
類型的描述。 |
|
名稱
|
Name | string |
類型的名稱。 |
|
XML 表單
|
XmlForm | string |
類型的 XML 表示法。 |
|
Fields
|
FieldInstances | array of WorkItemTypeFieldInstance |
與類型相關聯的欄位實例清單。 |
|
圖標標識號
|
icon.id | string |
圖示的識別碼 |
|
圖示網址
|
icon.url | string |
資源的 REST URL |
|
States
|
states | array of WorkItemStateColor |
工作專案類型的狀態 |
WorkItemTypeField實例
工作專案類型欄位實例
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
始終需要
|
AlwaysRequired | boolean |
指定欄位實例是否一律為必要。 |
|
參考名稱
|
ReferenceName | string |
欄位實例的參考名稱。 |
|
名稱
|
Name | string |
欄位執行個體的名稱。 |
|
URL
|
Url | string |
指向欄位實例詳細資料的 URL。 |
VstsList[JObject]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of Object |
VSTS 模型 |
VstsList[查詢階層專案]
VSTS 模型清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | array of QueryHierarchyItem |
VSTS 模型 |
查詢階層項目
查詢階層項目
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
孩童
|
Children | array of QueryHierarchyItem |
與查詢階層項目相關聯的子項目清單。 |
|
條款
|
Clauses | WorkItemQueryClause |
工作專案查詢子句 |
|
Columns
|
Columns | array of WorkItemFieldReference |
與查詢階層專案相關聯的工作專案欄位資料行清單。 |
|
篩選選項
|
FilterOptions | string |
查詢階層項目的篩選選項。 |
|
有孩子
|
HasChildren | boolean |
指定查詢階層項目是否有子項。 |
|
身份識別碼
|
Id | string |
查詢階層專案的唯一識別碼。 |
|
已刪除
|
IsDeleted | boolean |
指定是否刪除查詢階層項目。 |
|
是資料夾
|
IsFolder | boolean |
指定查詢階層項目是否為資料夾。 |
|
語法無效
|
IsInvalidSyntax | boolean |
指定查詢階層項目是否具有無效的語法。 |
|
是公開的
|
IsPublic | boolean |
指定查詢階層項目是否為公用。 |
|
Link子句
|
LinkClauses | WorkItemQueryClause |
工作專案查詢子句 |
|
名稱
|
Name | string |
查詢階層項目的名稱。 |
|
路徑
|
Path | string |
查詢階層項目的路徑。 |
|
查詢類型
|
QueryType | string |
查詢階層項目的查詢類型。 |
|
排序欄
|
SortColumns | array of WorkItemQuerySortColumn |
查詢階層項目的排序資料行清單。 |
|
Source子句
|
SourceClauses | WorkItemQueryClause |
工作專案查詢子句 |
|
Target子句
|
TargetClauses | WorkItemQueryClause |
工作專案查詢子句 |
|
Wiql
|
Wiql | string |
查詢階層專案的 WIQL。 |
|
Links
|
_links | object |
與查詢階層專案相關的連結集合。 |
|
URL
|
Url | string |
查詢階層專案的完整 HTTP 連結。 |
WorkItemStateColor
工作專案狀態色彩
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
狀態類別
|
category | string |
狀態類別 |
|
色彩值
|
color | string |
色彩值 |
|
州名稱
|
name | string |
工作項目類型狀態名稱 |
WorkItemQuery子句
工作專案查詢子句
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
條款
|
Clauses | WorkItemQueryClause |
工作專案查詢子句 |
|
領域
|
Field | WorkItemFieldReference |
工作專案欄位參考 |
|
欄位值
|
FieldValue | WorkItemFieldReference |
工作專案欄位參考 |
|
是欄位值
|
IsFieldValue | boolean |
指定工作專案查詢子句是否為欄位值。 |
|
邏輯運算子
|
LogicalOperator | string |
工作專案查詢子句的邏輯運算子。 |
|
Operator
|
Operator | WorkItemFieldOperation |
工作項目欄位作業 |
|
價值觀
|
Value | string |
工作專案查詢子句的值。 |
WorkItemField參考
工作專案欄位參考
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
Name | string |
工作專案欄位參考的名稱。 |
|
參考名稱
|
ReferenceName | string |
工作專案欄位參考的參考名稱。 |
|
URL
|
Url | string |
工作專案欄位參考的 URL。 |
WorkItemQuerySortColumn
工作專案查詢排序資料行
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Descending
|
Descending | boolean |
指定工作專案查詢排序資料行是否遞減。 |
|
領域
|
Field | WorkItemFieldReference |
工作專案欄位參考 |
WorkItemField作業
工作項目欄位作業
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
Name | string |
工作專案欄位作業的名稱。 |
|
參考名稱
|
ReferenceName | string |
工作專案欄位作業的參考名稱。 |
管線
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
count
|
count | integer |
count |
|
value
|
value | array of object |
具有所有管線清單的陣列 |
|
href
|
value._links.self.href | string |
href |
|
href
|
value._links.web.href | string |
href |
|
檔案夾
|
value.folder | string |
檔案夾 |
|
識別碼
|
value.id | integer |
識別碼 |
|
名稱
|
value.name | string |
名稱 |
|
修訂
|
value.revision | integer |
修訂 |
|
url
|
value.url | string |
url |
Run
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
count
|
count | integer |
count |
|
value
|
value | array of object |
管道運行 |
|
href
|
value._links.self.href | string | |
|
href
|
value._links.web.href | string | |
|
href
|
value._links.pipeline.web.href | string | |
|
href
|
value._links.pipeline.href | string | |
|
url
|
value.pipeline.url | string | |
|
識別碼
|
value.pipeline.id | integer | |
|
修訂
|
value.pipeline.revision | integer | |
|
名稱
|
value.pipeline.name | string | |
|
檔案夾
|
value.pipeline.folder | string | |
|
狀態
|
value.state | RunState |
執行狀態 |
|
建立日期
|
value.createdDate | string |
創建日期 |
|
url
|
value.url | string |
管線的 URL |
|
識別碼
|
value.id | integer |
管線識別碼 |
|
名稱
|
value.name | string |
名稱 |
|
結果
|
value.result | RunResult |
執行結果 |
|
完成日期
|
value.finishedDate | string |
執行完成日期 |