Builds - Queue

Service:

Build

API Version:

7.1-preview.7

將組建排入佇列

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.1-preview.7

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?ignoreWarnings={ignoreWarnings}&checkInTicket={checkInTicket}&sourceBuildId={sourceBuildId}&definitionId={definitionId}&api-version=7.1-preview.7

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 '7.1-preview.7' 以使用此版本的 API。
checkInTicket	query		string
definitionId	query		integer int32	選擇性的定義識別碼，用來將沒有主體的組建排入佇列。 如果有有效的本文，則會忽略
ignoreWarnings	query		boolean
sourceBuildId	query		integer int32

要求本文

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
agentSpecification	AgentSpecification	組建的代理程式規格。
appendCommitMessageToRunName	boolean	將認可訊息附加至 UI 中的 BuildNumber。
buildNumber	string	組建的組建編號/名稱。
buildNumberRevision	integer	組建編號修訂。
controller	BuildController	組建控制器。 只有在定義類型為 Xaml 時，才會設定此設定。
definition	DefinitionReference	與組建相關聯的定義。
deleted	boolean	指出是否已刪除組建。
deletedBy	IdentityRef	刪除組建之進程或人員的身分識別。
deletedDate	string	刪除組建的日期。
deletedReason	string	如何刪除組建的描述。
demands	Demand[]	代表此組建所需之代理程式功能的需求清單。
finishTime	string	建置完成的時間。
id	integer	組建的識別碼。
lastChangedBy	IdentityRef	代表上次變更組建之進程或人員的身分識別。
lastChangedDate	string	上次變更組建的日期。
logs	BuildLogReference	組建記錄的相關資訊。
orchestrationPlan	TaskOrchestrationPlanReference	組建的協調流程計畫。
parameters	string	組建的參數。
plans	TaskOrchestrationPlanReference[]	與組建相關聯的協調流程計畫 (組建、清除)
priority	QueuePriority	組建的優先順序。
project	TeamProjectReference	小組專案。
properties	PropertiesCollection	類別會將屬性包表示為索引鍵/值組的集合。 所有基本類型的值都會 (接受任何具有 TypeCode != TypeCode.Object) DBNull 的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型，其他基本類型則會重新調整為 String。 Byte[] 預期為 base64 編碼字串。
quality	string	xaml 組建的品質 (良好、不良等。)
queue	AgentPoolQueue	佇列。 只有在定義類型為 Build 時，才會設定此設定。 警告：此欄位已被取代，且不會對應至作業佇列。
queueOptions	QueueOptions	將組建排入佇列的其他選項。
queuePosition	integer	組建在佇列中的目前位置。
queueTime	string	組建排入佇列的時間。
reason	BuildReason	建立組建的原因。
repository	BuildRepository	存放庫。
requestedBy	IdentityRef	排入組建佇列的身分識別。
requestedFor	IdentityRef	代表組建排入佇列的身分識別。
result	BuildResult	建置結果。
retainedByRelease	boolean	指出組建是否由發行保留。
sourceBranch	string	來源分支。
sourceVersion	string	來源版本。
startTime	string	組建啟動的時間。
status	BuildStatus	組建的狀態。
tags	string[]
templateParameters	object	範本運算式評估的參數
triggerInfo	object	Sourceprovider 特定資訊，說明觸發建置的專案
triggeredByBuild	Build	透過建置完成觸發程式觸發此組建的組建。
uri	string	組建的 URI。
url	string	組建的 REST URL。
validationResults	BuildRequestValidationResult[]	表示驗證組建要求的結果。

回應

名稱	類型	Description
200 OK	Build	成功的作業

安全性

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.build_execute	授與存取組建成品的能力，包括建置結果、定義和要求，以及將組建排入佇列、更新組建屬性，以及透過服務勾點接收建置事件相關通知的能力。

定義

名稱	Description
AgentPoolQueue	表示執行組建的佇列。
AgentSpecification	集區提供者所定義的代理程式規格。
Build	組建的資料表示。
BuildController
BuildLogReference	表示組建記錄檔的參考。
BuildReason	建立組建的原因。
BuildRepository	表示組建定義所使用的存放庫。
BuildRequestValidationResult	表示驗證組建要求的結果。
BuildResult	建置結果。
BuildStatus	組建狀態。
ControllerStatus	控制器的狀態。
DefinitionQueueStatus	值，指出組建是否可以針對這個定義排入佇列。
DefinitionReference	表示定義的參考。
DefinitionType	定義的類型。
Demand	表示定義或組建所使用的需求。
IdentityRef
ProjectState	專案狀態。
ProjectVisibility	專案可見度。
PropertiesCollection	類別會將屬性包表示為索引鍵/值組的集合。 所有基本類型的值都會 (接受任何具有 TypeCode != TypeCode.Object) DBNull 的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型，其他基本類型則會重新調整為 String。 Byte[] 預期為 base64 編碼字串。
QueueOptions	佇列建置的其他選項。
QueuePriority	組建的優先順序。
ReferenceLinks	表示 REST 參考連結集合的類別。
TaskAgentPoolReference	表示代理程式組件區的參考。
TaskOrchestrationPlanReference	表示協調流程計畫的參考。
TeamProjectReference	表示 TeamProject 的淺層參考。
ValidationResult	結果。

AgentPoolQueue

表示執行組建的佇列。

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
id	integer	佇列的識別碼。
name	string	佇列的名稱。
pool	TaskAgentPoolReference	這個佇列所使用的集區。
url	string	資源的完整 HTTP 連結。

AgentSpecification

集區提供者所定義的代理程式規格。

名稱	類型	Description
identifier	string	代理程式規格唯一識別碼。

Build

組建的資料表示。

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
agentSpecification	AgentSpecification	組建的代理程式規格。
appendCommitMessageToRunName	boolean	將認可訊息附加至 UI 中的 BuildNumber。
buildNumber	string	組建的組建編號/名稱。
buildNumberRevision	integer	組建編號修訂。
controller	BuildController	組建控制器。 只有在定義類型為 Xaml 時，才會設定此設定。
definition	DefinitionReference	與組建相關聯的定義。
deleted	boolean	指出是否已刪除組建。
deletedBy	IdentityRef	刪除組建之進程或人員的身分識別。
deletedDate	string	刪除組建的日期。
deletedReason	string	如何刪除組建的描述。
demands	Demand[]	要求清單，表示此組建所需的代理程式功能。
finishTime	string	建置完成的時間。
id	integer	組建的識別碼。
lastChangedBy	IdentityRef	身分識別，代表上次變更組建的進程或人員。
lastChangedDate	string	上次變更組建的日期。
logs	BuildLogReference	組建記錄的相關資訊。
orchestrationPlan	TaskOrchestrationPlanReference	組建的協調流程計畫。
parameters	string	組建的參數。
plans	TaskOrchestrationPlanReference[]	與組建 (建置相關聯的協調流程計畫、清除)
priority	QueuePriority	組建的優先順序。
project	TeamProjectReference	小組專案。
properties	PropertiesCollection	類別會將屬性包表示為索引鍵/值組的集合。 所有基本型別的值都會 (接受任何具有 TypeCode != TypeCode.Object) DBNull 的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型，其他基本類型會重新調整為 String。 Byte[] 預期為 base64 編碼字串。
quality	string	xaml 組建的品質 (良好、不良等。)
queue	AgentPoolQueue	佇列。 只有在定義類型為 Build 時，才會設定此設定。 警告：此欄位已被取代，且不會對應至作業佇列。
queueOptions	QueueOptions	佇列建置的其他選項。
queuePosition	integer	組建在佇列中的目前位置。
queueTime	string	組建排入佇列的時間。
reason	BuildReason	建立組建的原因。
repository	BuildRepository	存放庫。
requestedBy	IdentityRef	排入組建佇列的身分識別。
requestedFor	IdentityRef	代表組建排入佇列的身分識別。
result	BuildResult	建置結果。
retainedByRelease	boolean	指出組建是否由版本保留。
sourceBranch	string	來源分支。
sourceVersion	string	來源版本。
startTime	string	組建啟動的時間。
status	BuildStatus	組建的狀態。
tags	string[]
templateParameters	object	範本運算式評估的參數
triggerInfo	object	Sourceprovider 特定資訊，關於觸發建置的專案
triggeredByBuild	Build	透過建置完成觸發程式觸發此組建的組建。
uri	string	組建的 URI。
url	string	組建的 REST URL。
validationResults	BuildRequestValidationResult[]	表示驗證組建要求的結果。

BuildController

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
createdDate	string	建立控制器的日期。
description	string	控制器的描述。
enabled	boolean	指出是否啟用控制器。
id	integer	資源的識別碼
name	string	連結資源的名稱 (定義名稱、控制器名稱等。)
status	ControllerStatus	控制器的狀態。
updatedDate	string	控制器上次更新的日期。
uri	string	控制器的 URI。
url	string	資源的完整 HTTP 連結

BuildLogReference

表示組建記錄檔的參考。

名稱	類型	Description
id	integer	記錄檔的識別碼。
type	string	記錄位置的類型。
url	string	記錄資源的完整連結。

BuildReason

建立組建的原因。

名稱	類型	Description
all	string	所有原因。
batchedCI	string	已啟動觸發程式 TriggerType.BatchedContinuousIntegration 的組建。
buildCompletion	string	建置是在另一個組建完成時啟動。
checkInShelveset	string	已針對觸發程式 ContinuousIntegrationType.Gated 啟動組建。
individualCI	string	已啟動觸發程式 TriggerType.ContinuousIntegration 的組建。
manual	string	組建已手動啟動。
none	string	無理由。 不應使用此值。
pullRequest	string	組建是由提取要求啟動。 已在資源第 3 版中新增。
resourceTrigger	string	在管線中的資源觸發建置時啟動
schedule	string	已啟動觸發程式 TriggerType.Schedule 的組建。
scheduleForced	string	已啟動觸發程式 TriggerType.ScheduleForced 的組建。
triggered	string	建置已針對保留原則而觸發。
userCreated	string	組建是由使用者所建立。
validateShelveset	string	建置已手動啟動以進行私用驗證。

BuildRepository

表示組建定義所使用的存放庫。

名稱	類型	Description
checkoutSubmodules	boolean	指出是否要簽出子模組。
clean	string	指出從存放庫取得程式碼時是否要清除目的檔案夾。
defaultBranch	string	預設分支的名稱。
id	string	存放庫的識別碼。
name	string	存放庫的易記名稱。
properties	object
rootFolder	string	根資料夾。
type	string	存放庫的類型。
url	string	存放庫的 URL。

BuildRequestValidationResult

表示驗證組建要求的結果。

名稱	類型	Description
message	string	與結果相關聯的訊息。
result	ValidationResult	結果。

BuildResult

建置結果。

名稱	類型	Description
canceled	string	組建在啟動之前已取消。
failed	string	建置未順利完成。
none	string	無結果
partiallySucceeded	string	建置成功完成編譯，但發生其他錯誤。
succeeded	string	建置成功完成。

BuildStatus

組建狀態。

名稱	類型	Description
all	string	所有狀態。
cancelling	string	組建正在取消
completed	string	組建已完成。
inProgress	string	組建目前正在進行中。
none	string	無狀態。
notStarted	string	組建尚未啟動。
postponed	string	組建在佇列中處於非作用中狀態。

ControllerStatus

控制器的狀態。

名稱	類型	Description
available	string	指出組建控制器目前可供使用。
offline	string	表示組建控制器已離線。
unavailable	string	表示無法連絡組建控制器。

DefinitionQueueStatus

值，指出組建是否可以針對這個定義排入佇列。

名稱	類型	Description
disabled	string	停用時，定義佇列不允許使用者將組建排入佇列，而且系統不會排入排程、閘道或持續整合組建的佇列。 佇列中的組建將不會由系統啟動。
enabled	string	啟用定義佇列可讓使用者將組建排入佇列時，系統會將排程、閘道和持續整合組建排入佇列，而佇列組建將會由系統啟動。
paused	string	暫停時，定義佇列可讓使用者將組建排入佇列，而且系統會排入排程、閘道和持續整合組建的佇列。 佇列中的組建將不會由系統啟動。

DefinitionReference

表示定義的參考。

名稱	類型	Description
createdDate	string	建立此定義版本的日期。
id	integer	參考定義的識別碼。
name	string	參考定義的名稱。
path	string	定義的資料夾路徑。
project	TeamProjectReference	專案的參考。
queueStatus	DefinitionQueueStatus	值，指出組建是否可以針對此定義排入佇列。
revision	integer	定義修訂編號。
type	DefinitionType	定義的類型。
uri	string	定義的 URI。
url	string	定義的 REST URL。

DefinitionType

定義的類型。

名稱	類型	Description
build	string
xaml	string

Demand

表示定義或組建所使用的需求。

名稱	類型	Description
name	string	需求所參考的功能名稱。
value	string	要求的值。

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
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 是此圖表主體來源資源的完整路由。

ProjectState

專案狀態。

名稱	類型	Description
all	string	所有專案，不論刪除以外的狀態為何。
createPending	string	專案已排入佇列以建立，但程式尚未啟動。
deleted	string	專案已刪除。
deleting	string	Project 正在刪除。
new	string	Project 正在建立中。
unchanged	string	專案尚未變更。
wellFormed	string	Project 已完全建立並可供使用。

ProjectVisibility

專案可見度。

名稱	類型	Description
private	string	只有具有明確存取權的使用者才能看到專案。
public	string	專案對全部可見。

PropertiesCollection

類別會將屬性包表示為索引鍵/值組的集合。 所有基本類型的值都會 (接受任何具有 TypeCode != TypeCode.Object) DBNull 的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型，其他基本類型則會重新調整為 String。 Byte[] 預期為 base64 編碼字串。

名稱	類型	Description
count	integer	集合中的屬性計數。
item	object
keys	string[]	集合中的索引鍵集合。
values	string[]	集合中的值集合。

QueueOptions

佇列建置的其他選項。

名稱	類型	Description
doNotRun	string	建立組建的計畫識別碼，請勿執行
none	string	沒有佇列選項

QueuePriority

組建的優先順序。

名稱	類型	Description
aboveNormal	string	高於一般優先順序。
belowNormal	string	低於一般優先順序。
high	string	高優先順序。
low	string	低優先順序。
normal	string	一般優先順序。

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。 因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

TaskAgentPoolReference

表示代理程式組件區的參考。

名稱	類型	Description
id	integer	集區識別碼。
isHosted	boolean	值，指出此集區是否由服務管理。
name	string	集區名稱。

TaskOrchestrationPlanReference

表示協調流程計畫的參考。

名稱	類型	Description
orchestrationType	integer	計畫的型別。
planId	string	方案的識別碼。

TeamProjectReference

表示 TeamProject 的淺層參考。

名稱	類型	Description
abbreviation	string	專案縮寫。
defaultTeamImageUrl	string	預設小組身分識別影像的 URL。
description	string	如果有任何) ，專案的描述 (。
id	string	專案識別碼。
lastUpdateTime	string	專案上次更新時間。
name	string	專案名稱。
revision	integer	專案修訂。
state	ProjectState	專案狀態。
url	string	物件完整版本的 URL。
visibility	ProjectVisibility	專案可見度。

ValidationResult

結果。

名稱	類型	Description
error	string
ok	string
warning	string