共用方式為


Templates - Get

取得特定的組建定義範本。

GET https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates/{templateId}?api-version=5.0

URI 參數

名稱 位於 必要 類型 Description
organization
path True

string

Azure DevOps 組織的名稱。

project
path True

string

專案識別碼或專案名稱

templateId
path True

string

所要求範本的識別碼。

api-version
query True

string

要使用的 API 版本。 這應該設定為 '5.0' 以使用此版本的 API。

回應

名稱 類型 Description
200 OK

BuildDefinitionTemplate

成功的作業

安全性

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 授與存取組建成品的能力,包括建置結果、定義和要求,以及透過服務勾點接收建置事件相關通知的能力。

定義

名稱 Description
AgentPoolQueue

表示執行組建的佇列。

AuthorizationHeader
Build

組建的資料表示。

BuildAuthorizationScope

針對此定義排入佇列的組建作業授權範圍。

BuildController
BuildDefinition

表示組建定義。

BuildDefinitionTemplate

表示可從中建立新組建定義的範本。

BuildDefinitionVariable

表示組建定義所使用的變數。

BuildLogReference

表示組建記錄檔的參考。

BuildMetric

表示系統中組建的相關中繼資料。

BuildOption

表示將選擇性行為套用至組建定義。

BuildOptionDefinitionReference

表示建置選項定義的參考。

BuildProcess

表示建置程式。

BuildReason

建立組建的原因。

BuildRepository

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

BuildRequestValidationResult

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

BuildResult

建置結果。

BuildStatus

組建狀態。

BuildTrigger

表示 buld 定義的觸發程式。

ControllerStatus

控制器的狀態。

DataSourceBindingBase

表示服務端點要求的資料來源系結。

DefinitionQuality

定義檔的品質 (草稿等)

DefinitionQueueStatus

值,指出組建是否可以針對此定義排入佇列。

DefinitionReference

表示定義的參考。

DefinitionTriggerType

觸發程序的類型。

DefinitionType

定義的類型。

Demand

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

IdentityRef
ProcessParameters
ProjectState

專案狀態。

ProjectVisibility

專案可見度。

PropertiesCollection

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

QueueOptions

將組建排入佇列的其他選項。

QueuePriority

組建的優先順序。

ReferenceLinks

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

RetentionPolicy

表示組建定義的保留原則。

TaskAgentPoolReference

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

TaskInputDefinitionBase
TaskInputValidation
TaskOrchestrationPlanReference

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

TaskSourceDefinitionBase
TeamProjectReference

表示 TeamProject 的淺層參考。

ValidationResult

結果。

VariableGroup

表示變數群組。

AgentPoolQueue

表示執行組建的佇列。

名稱 類型 Description
_links

ReferenceLinks

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

id

integer

佇列的識別碼。

name

string

佇列的名稱。

pool

TaskAgentPoolReference

這個佇列所使用的集區。

url

string

資源的完整 HTTP 連結。

AuthorizationHeader

名稱 類型 Description
name

string

value

string

Build

組建的資料表示。

名稱 類型 Description
_links

ReferenceLinks

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

buildNumber

string

組建的組建編號/名稱。

buildNumberRevision

integer

組建編號修訂。

controller

BuildController

組建控制器。 只有在定義類型為 Xaml 時,才會設定此設定。

definition

DefinitionReference

與組建相關聯的定義。

deleted

boolean

指出是否已刪除組建。

deletedBy

IdentityRef

刪除組建之進程或人員的身分識別。

deletedDate

string

刪除組建的日期。

deletedReason

string

如何刪除組建的描述。

demands

Demand[]

代表此組建所需之代理程式功能的需求清單。

finishTime

string

建置完成的時間。

id

integer

組建的識別碼。

keepForever

boolean

指出是否應該由保留原則略過組建。

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[]

triggerInfo

object

Sourceprovider 特定資訊,說明觸發建置的專案

triggeredByBuild

Build

透過建置完成觸發程式觸發此組建的組建。

uri

string

組建的 URI。

url

string

組建的 REST URL。

validationResults

BuildRequestValidationResult[]

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

BuildAuthorizationScope

針對此定義排入佇列的組建作業授權範圍。

名稱 類型 Description
project

string

使用的身分識別應該具有組建定義所在專案的組建服務帳戶許可權。 這適用于將建置作業隔離至特定小組專案,以避免在建置期間意外擴大許可權攻擊。

projectCollection

string

使用的身分識別應該具有範圍設定為專案集合的組建服務帳戶許可權。 當單一組建的資源分散到多個專案時,這非常有用。

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 連結

BuildDefinition

表示組建定義。

名稱 類型 Description
_links

ReferenceLinks

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

authoredBy

IdentityRef

定義的作者。

badgeEnabled

boolean

指出是否為此定義啟用徽章。

buildNumberFormat

string

組建編號格式。

comment

string

定義的節省時間批註。

createdDate

string

定義建立的日期。

demands

Demand[]

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

description

string

描述。

draftOf

DefinitionReference

如果這是草稿定義,則為定義之定義的參考。

drafts

DefinitionReference[]

如果這不是草稿定義,則為與此定義相關聯的草稿清單。

dropLocation

string

定義的置放位置。

id

integer

參考定義的識別碼。

jobAuthorizationScope

BuildAuthorizationScope

針對此定義排入佇列的組建作業授權範圍。

jobCancelTimeoutInMinutes

integer

作業取消逾時 (分鐘) 使用者針對此定義取消的組建。

jobTimeoutInMinutes

integer

針對針對此定義排入佇列的組建,作業執行逾時 (分鐘) 。

latestBuild

Build

組建的資料表示。

latestCompletedBuild

Build

組建的資料表示。

metrics

BuildMetric[]

表示系統中組建的相關中繼資料。

name

string

參考定義的名稱。

options

BuildOption[]

表示將選擇性行為套用至組建定義。

path

string

定義的資料夾路徑。

process

BuildProcess

建置程式。

processParameters

ProcessParameters

這個定義的進程參數。

project

TeamProjectReference

專案的參考。

properties

PropertiesCollection

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

quality

DefinitionQuality

定義檔的品質 (草稿等)

queue

AgentPoolQueue

針對此定義執行組建的預設佇列。

queueStatus

DefinitionQueueStatus

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

repository

BuildRepository

存放庫。

retentionRules

RetentionPolicy[]

表示組建定義的保留原則。

revision

integer

定義修訂編號。

tags

string[]

triggers

BuildTrigger[]

表示 buld 定義的觸發程式。

type

DefinitionType

定義的類型。

uri

string

定義的 URI。

url

string

定義的 REST URL。

variableGroups

VariableGroup[]

表示變數群組。

variables

<string,  BuildDefinitionVariable>

BuildDefinitionTemplate

表示可從中建立新組建定義的範本。

名稱 類型 Description
canDelete

boolean

指出是否可以刪除範本。

category

string

範本類別。

defaultHostedQueue

string

預設為範本使用的選擇性託管代理程式佇列。

description

string

範本的描述。

iconTaskId

string

在 UI 中顯示此範本時,會使用其圖示的工作識別碼。

icons

object

id

string

範本的識別碼。

name

string

範本名稱。

template

BuildDefinition

實際範本。

BuildDefinitionVariable

表示組建定義所使用的變數。

名稱 類型 Description
allowOverride

boolean

指出是否可以在佇列時間設定值。

isSecret

boolean

指出變數的值是否為秘密。

value

string

變數的值。

BuildLogReference

表示組建記錄檔的參考。

名稱 類型 Description
id

integer

記錄檔的識別碼。

type

string

記錄位置的類型。

url

string

記錄資源的完整連結。

BuildMetric

表示系統中組建的相關中繼資料。

名稱 類型 Description
date

string

範圍的日期。

intValue

integer

數值。

name

string

計量的名稱。

scope

string

範圍。

BuildOption

表示將選擇性行為套用至組建定義。

名稱 類型 Description
definition

BuildOptionDefinitionReference

建置選項的參考。

enabled

boolean

指出是否啟用行為。

inputs

object

BuildOptionDefinitionReference

表示建置選項定義的參考。

名稱 類型 Description
id

string

參考之建置選項的識別碼。

BuildProcess

表示建置程式。

名稱 類型 Description
type

integer

處理的類型。

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 版中新增。

schedule

string

已啟動觸發程式 TriggerType.Schedule 的組建。

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

組建在佇列中處於非作用中狀態。

BuildTrigger

表示 buld 定義的觸發程式。

名稱 類型 Description
triggerType

DefinitionTriggerType

觸發程序的類型。

ControllerStatus

控制器的狀態。

名稱 類型 Description
available

string

表示組建控制器目前可供使用。

offline

string

表示組建控制器已離線。

unavailable

string

表示無法連絡組建控制器。

DataSourceBindingBase

表示服務端點要求的資料來源系結。

名稱 類型 Description
callbackContextTemplate

string

這個資料來源支援的分頁格式 (ContinuationToken/SkipTop) 。

callbackRequiredTemplate

string

後續需要呼叫嗎?

dataSourceName

string

取得或設定資料來源的名稱。

endpointId

string

取得或設定端點識別碼。

endpointUrl

string

取得或設定服務端點的 URL。

headers

AuthorizationHeader[]

取得或設定授權標頭。

initialContextTemplate

string

定義查詢參數的初始值

parameters

object

取得或設定資料來源的參數。

resultSelector

string

取得或設定結果選取器。

resultTemplate

string

取得或設定結果範本。

target

string

取得或設定資料來源的目標。

DefinitionQuality

定義檔的品質 (草稿等)

名稱 類型 Description
definition

string

draft

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。

DefinitionTriggerType

觸發程序的類型。

名稱 類型 Description
all

string

所有類型。

batchedContinuousIntegration

string

應該在指定的間隔一次針對多個變更集啟動組建。

batchedGatedCheckIn

string

每個簽入批次都應該啟動驗證組建。

buildCompletion

string

當另一個組建完成時,應該觸發組建。

continuousIntegration

string

每個變更集都應該啟動組建。

gatedCheckIn

string

每個簽入都應該啟動驗證組建。

none

string

僅限手動建置。

pullRequest

string

建立或更新 GitHub 提取要求時,應該觸發組建。 已在資源第 3 版中新增

schedule

string

不論變更集是否存在,都應該在指定的排程上啟動組建。

DefinitionType

定義的類型。

名稱 類型 Description
build

string

xaml

string

Demand

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

名稱 類型 Description
name

string

需求所參考的功能名稱。

value

string

所需的值。

IdentityRef

名稱 類型 Description
_links

ReferenceLinks

此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性,或取得此圖表主體的詳細資訊。

descriptor

string

描述項是在系統執行時參考圖形主旨的主要方式。 此欄位可唯一識別帳戶和組織之間的相同圖表主旨。

directoryAlias

string

displayName

string

這是圖表主旨的非唯一顯示名稱。 若要變更此欄位,您必須在來源提供者中變更其值。

id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

url

string

此 URL 是此圖表主體來源資源的完整路由。

ProcessParameters

名稱 類型 Description
dataSourceBindings

DataSourceBindingBase[]

表示服務端點要求的資料來源系結。

inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectState

專案狀態。

名稱 類型 Description
all

string

不論狀態為何,所有專案。

createPending

string

Project 已排入佇列以供建立,但程式尚未啟動。

deleted

string

專案已刪除。

deleting

string

Project 正在刪除。

new

string

Project 正在建立中。

unchanged

string

Project 尚未變更。

wellFormed

string

專案已完全建立且可供使用。

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

一般優先順序。

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

名稱 類型 Description
links

object

連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。

RetentionPolicy

表示組建定義的保留原則。

名稱 類型 Description
artifactTypesToDelete

string[]

artifacts

string[]

branches

string[]

daysToKeep

integer

保留組建的天數。

deleteBuildRecord

boolean

指出是否應該刪除組建記錄本身。

deleteTestResults

boolean

指出是否要刪除與組建相關聯的測試結果。

minimumToKeep

integer

要保留的組建數目下限。

TaskAgentPoolReference

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

名稱 類型 Description
id

integer

集區識別碼。

isHosted

boolean

值,指出此集區是否由服務管理。

name

string

集區名稱。

TaskInputDefinitionBase

名稱 類型 Description
aliases

string[]

defaultValue

string

groupName

string

helpMarkDown

string

label

string

name

string

options

object

properties

object

required

boolean

type

string

validation

TaskInputValidation

visibleRule

string

TaskInputValidation

名稱 類型 Description
expression

string

條件運算式

message

string

說明使用者如何在驗證失敗時更正的訊息

TaskOrchestrationPlanReference

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

名稱 類型 Description
orchestrationType

integer

計畫的型別。

planId

string

方案的識別碼。

TaskSourceDefinitionBase

名稱 類型 Description
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

TeamProjectReference

表示 TeamProject 的淺層參考。

名稱 類型 Description
abbreviation

string

專案縮寫。

defaultTeamImageUrl

string

預設小組身分識別影像的 URL。

description

string

如果有任何) ,專案的描述 (。

id

string

專案識別碼。

name

string

專案名稱。

revision

integer

專案修訂。

state

ProjectState

專案狀態。

url

string

物件完整版本的 URL。

visibility

ProjectVisibility

專案可見度。

ValidationResult

結果。

名稱 類型 Description
error

string

oK

string

warning

string

VariableGroup

表示變數群組。

名稱 類型 Description
alias

string

變數群組的名稱。

description

string

描述。

id

integer

變數群組的識別碼。

name

string

變數群組的名稱。

type

string

變數群組的類型。

variables

<string,  BuildDefinitionVariable>