BuildRestClient class

參考

套件:: azure-devops-extension-api

應該 (衍生自) 的基類對 VSS REST API 提出要求

Extends: RestClientBase

建構函式

BuildRestClient(IVssRestClientOptions)

屬性

RESOURCE_AREA_ID

方法

addBuildTag(string, number, string)	將標籤新增至組建。
addBuildTags(string[], string, number)	將標籤新增至組建。
addDefinitionTag(string, number, string)	將標籤新增至定義
addDefinitionTags(string[], string, number)	將多個標記新增至定義。
addRetentionLeases(NewRetentionLease[], string)	新增管線執行的新租用。
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	建立成品與組建的關聯。
createDefinition(BuildDefinition, string, number, number)	建立新的定義。
createFolder(Folder, string, string)	建立新的資料夾。
deleteBuild(string, number)	刪除組建。
deleteBuildTag(string, number, string)	從組建中移除標記。注意：此 API 不適用於具有特殊字元的標籤。若要移除具有特殊字元的標記，請改用 PATCH 方法， (6.0+)
deleteDefinition(string, number)	刪除定義和所有相關聯的組建。
deleteDefinitionTag(string, number, string)	從定義中移除標記。注意：此 API 不適用於具有特殊字元的標籤。若要移除具有特殊字元的標記，請改用 PATCH 方法， (6.0+)
deleteFolder(string, string)	刪除定義資料夾。也會刪除定義及其對應的組建。
deleteRetentionLeasesById(string, number[])	移除特定的保留租用。
deleteTag(string, string)	從組建、定義和標籤存放區中移除標記
deleteTemplate(string, string)	刪除組建定義範本。
getArtifact(string, number, string)	取得組建的特定成品。
getArtifactContentZip(string, number, string)	取得組建的特定成品。
getArtifacts(string, number)	取得組建的所有成品。
getAttachment(string, number, string, string, string, string)	取得特定的附件。
getAttachments(string, number, string)	取得與組建相關聯之特定類型的附件清單。
getBadge(string, number, string)	取得徽章，指出定義的最新組建狀態。請注意，此 API 已被取代。偏好 StatusBadgeController.GetStatusBadge。
getBuild(string, number, string)	取得組建
getBuildBadge(string, string, string, string)	取得徽章，指出指定分支的最新組建狀態。
getBuildBadgeData(string, string, string, string)	取得徽章，指出指定分支的最新組建狀態。
getBuildChanges(string, number, string, number, boolean)	取得與組建相關聯的變更
getBuildController(number)	取得控制器
getBuildControllers(string)	取得控制器，選擇性地依名稱篩選
getBuildGeneralSettings(string)	取得管線一般設定。
getBuildLog(string, number, number, number, number)	取得組建的個別記錄檔。
getBuildLogLines(string, number, number, number, number)	取得組建的個別記錄檔。
getBuildLogs(string, number)	取得組建的記錄。
getBuildLogsZip(string, number)	取得組建的記錄。
getBuildLogZip(string, number, number, number, number)	取得組建的個別記錄檔。
getBuildOptionDefinitions(string)	取得系統支援的所有組建定義選項。
getBuildProperties(string, number, string[])	取得組建的屬性。
getBuildReport(string, number, string)	取得組建報表。
getBuildReportHtmlContent(string, number, string)	取得組建報表。
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	取得組建清單。
getBuildSettings(string)	取得組建設定。
getBuildTags(string, number)	取得組建的標記。
getBuildTimeline(string, number, string, number, string)	取得組建的詳細資料
getBuildWorkItemsRefs(string, number, number)	取得與組建相關聯的工作專案。只會傳回相同專案中的工作專案。
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	取得與組建相關聯的工作專案，篩選為特定認可。
getChangesBetweenBuilds(string, number, number, number)	取得在兩個指定組建之間對存放庫所做的變更。
getDefinition(string, number, number, Date, string[], boolean)	取得定義，選擇性地在特定修訂中。
getDefinitionMetrics(string, number, Date)	取得定義的建置計量。
getDefinitionProperties(string, number, string[])	取得定義的屬性。
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	取得定義的所有修訂。
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	取得定義清單。
getDefinitionTags(string, number, number)	取得定義的標記。
getDefinitionYaml(string, number, number, Date, string[], boolean)	選擇性地在特定修訂中，將定義轉換為 YAML。
getFile(string, number, string, string, string)	從組建取得檔案。
getFileContents(string, string, string, string, string, string)	取得指定原始程式碼存放庫中檔案的內容。
getFolders(string, string, FolderQueryOrder)	取得組建定義資料夾的清單。
getLatestBuild(string, string, string)	取得定義的最新組建，選擇性地限定為特定分支。
getPathContents(string, string, string, string, string, string)	取得指定原始程式碼存放庫中目錄的內容。
getProjectMetrics(string, string, Date)	取得專案的建置計量。
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	從來源提供者取得提取要求物件。
getResourceUsage()	取得系統中建置資源的相關資訊。
getRetentionHistory(number)	傳回專案集合的保留歷程記錄。這包括具有自訂保留規則的管線，這些規則可能會防止保留作業清除、每個管線執行，其中包含保留類型、與具有保留類型之集合所擁有的管線相關聯的檔案，以及每個管線的檔案數目。
getRetentionLease(string, number)	傳回指定租用識別碼的保留租用詳細資料。
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	傳回符合指定之 MinimalRetentionLeases 的任何租用
getRetentionLeasesByOwnerId(string, string, number, number)	傳回指定實體所擁有的任何租用，選擇性地限定為單一管線定義並執行。
getRetentionLeasesByUserId(string, string, number, number)	傳回指定使用者所擁有的任何租用，選擇性地限定為單一管線定義並執行。
getRetentionLeasesForBuild(string, number)	取得套用至特定組建的所有保留租用。
getRetentionSettings(string)	取得專案的保留設定。
getStatusBadge(string, string, string, string, string, string, string)	<p > 取得定義的組建狀態，選擇性地限定為特定分支、階段、作業和組態。 </p p ><> 如果有多個，則在指定 jobName 時需要傳入 stageName 值，而且如果傳遞組態參數，則會套用相同的規則。 </P>
getTags(string)	取得專案中所有建置標記的清單。
getTemplate(string, string)	取得特定的組建定義範本。
getTemplates(string)	取得所有定義範本。
getWorkItemsBetweenBuilds(string, number, number, number)	取得兩個組建之間的所有工作專案。
listBranches(string, string, string, string, string)	取得指定原始程式碼存放庫的分支清單。
listRepositories(string, string, string, string, ResultSet, boolean, string)	取得原始程式碼存放庫的清單。
listSourceProviders(string)	取得來源提供者及其功能的清單。
listWebhooks(string, string, string, string)	取得指定原始程式碼存放庫中安裝的 Webhook 清單。
queueBuild(Build, string, boolean, string, number, number)	將組建排入佇列
restoreDefinition(string, number, boolean)	還原已刪除的定義
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	為指定原始程式碼存放庫中的指定觸發程式重新建立 Webhook。
saveTemplate(BuildDefinitionTemplate, string, string)	更新現有的組建定義範本。
updateBuild(Build, string, number, boolean)	更新組建。
updateBuildGeneralSettings(PipelineGeneralSettings, string)	更新管線一般設定。
updateBuildProperties(JsonPatchDocument, string, number)	更新組建的屬性。
updateBuilds(Build[], string)	更新多個組建。
updateBuildSettings(BuildSettings, string)	更新組建設定。
updateBuildTags(UpdateTagParameters, string, number)	從組建新增/移除標記。
updateDefinition(BuildDefinition, string, number, number, number)	更新現有的組建定義。為了讓此作業成功，要求主體的「Revision」屬性值必須符合現有的組建定義。建議您使用 GET 取得現有的組建定義、視需要修改組建定義，然後使用 PUT 提交修改的定義。
updateDefinitionProperties(JsonPatchDocument, string, number)	更新定義的屬性。
updateDefinitionTags(UpdateTagParameters, string, number)	從定義新增/移除標記。
updateFolder(Folder, string, string)	更新位於指定現有路徑的現有資料夾
updateRetentionLease(RetentionLeaseUpdate, string, number)	更新保留租用的持續時間或管線保護狀態。
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	更新專案的保留設定。
updateStage(UpdateStageParameters, number, string, string)	更新組建階段

建構函式詳細資料

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

參數

options: IVssRestClientOptions

屬性詳細資料

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

屬性值

string

方法詳細資料

addBuildTag(string, number, string)

將標籤新增至組建。

function addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

tag: string

要加入的標記。

傳回

Promise<string[]>

addBuildTags(string[], string, number)

將標籤新增至組建。

function addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>

參數

tags: string[]

要加入的標記。要求本文會直接從列出的標籤組成。

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<string[]>

addDefinitionTag(string, number, string)

將標籤新增至定義

function addDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

tag: string

要加入的標記。

傳回

Promise<string[]>

addDefinitionTags(string[], string, number)

將多個標記新增至定義。

function addDefinitionTags(tags: string[], project: string, definitionId: number): Promise<string[]>

參數

tags: string[]

要加入的標記。

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

傳回

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

新增管線執行的新租用。

function addRetentionLeases(newLeases: NewRetentionLease[], project: string): Promise<RetentionLease[]>

參數

newLeases: NewRetentionLease[]

project: string

專案識別碼或專案名稱

傳回

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

function authorizeDefinitionResources(resources: DefinitionResourceReference[], project: string, definitionId: number): Promise<DefinitionResourceReference[]>

參數

resources: DefinitionResourceReference[]

project: string

專案識別碼或專案名稱

definitionId: number

傳回

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

function authorizeProjectResources(resources: DefinitionResourceReference[], project: string): Promise<DefinitionResourceReference[]>

參數

resources: DefinitionResourceReference[]

project: string

專案識別碼或專案名稱

傳回

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

建立成品與組建的關聯。

function createArtifact(artifact: BuildArtifact, project: string, buildId: number): Promise<BuildArtifact>

參數

artifact: BuildArtifact

成品。

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

建立新的定義。

function createDefinition(definition: BuildDefinition, project: string, definitionToCloneId?: number, definitionToCloneRevision?: number): Promise<BuildDefinition>

參數

definition: BuildDefinition

定義。

project: string

專案識別碼或專案名稱

definitionToCloneId: number

definitionToCloneRevision: number

傳回

Promise<BuildDefinition>

createFolder(Folder, string, string)

建立新的資料夾。

function createFolder(folder: Folder, project: string, path: string): Promise<Folder>

參數

folder: Folder

資料夾。

project: string

專案識別碼或專案名稱

path: string

資料夾的完整路徑。

傳回

Promise<Folder>

deleteBuild(string, number)

刪除組建。

function deleteBuild(project: string, buildId: number): Promise<void>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<void>

deleteBuildTag(string, number, string)

從組建中移除標記。注意：此 API 不適用於具有特殊字元的標籤。若要移除具有特殊字元的標記，請改用 PATCH 方法， (6.0+)

function deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

tag: string

要移除的標記。

傳回

Promise<string[]>

deleteDefinition(string, number)

刪除定義和所有相關聯的組建。

function deleteDefinition(project: string, definitionId: number): Promise<void>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

傳回

Promise<void>

deleteDefinitionTag(string, number, string)

從定義中移除標記。注意：此 API 不適用於具有特殊字元的標籤。若要移除具有特殊字元的標記，請改用 PATCH 方法， (6.0+)

function deleteDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

tag: string

要移除的標記。

傳回

Promise<string[]>

deleteFolder(string, string)

刪除定義資料夾。也會刪除定義及其對應的組建。

function deleteFolder(project: string, path: string): Promise<void>

參數

project: string

專案識別碼或專案名稱

path: string

資料夾的完整路徑。

傳回

Promise<void>

deleteRetentionLeasesById(string, number[])

移除特定的保留租用。

function deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>

參數

project: string

專案識別碼或專案名稱

ids: number[]

傳回

Promise<void>

deleteTag(string, string)

從組建、定義和標籤存放區中移除標記

function deleteTag(project: string, tag: string): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

tag: string

要移除的標記。

傳回

Promise<string[]>

deleteTemplate(string, string)

刪除組建定義範本。

function deleteTemplate(project: string, templateId: string): Promise<void>

參數

project: string

專案識別碼或專案名稱

templateId: string

範本的識別碼。

傳回

Promise<void>

getArtifact(string, number, string)

取得組建的特定成品。

function getArtifact(project: string, buildId: number, artifactName: string): Promise<BuildArtifact>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

artifactName: string

成品的名稱。

傳回

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

取得組建的特定成品。

function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

artifactName: string

成品的名稱。

傳回

Promise<ArrayBuffer>

getArtifacts(string, number)

取得組建的所有成品。

function getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<BuildArtifact[]>

getAttachment(string, number, string, string, string, string)

取得特定的附件。

function getAttachment(project: string, buildId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

timelineId: string

時程表的識別碼。

recordId: string

時程表記錄的識別碼。

type: string

附件的類型。

name: string

附件的名稱。

傳回

Promise<ArrayBuffer>

getAttachments(string, number, string)

取得與組建相關聯之特定類型的附件清單。

function getAttachments(project: string, buildId: number, type: string): Promise<Attachment[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

type: string

附件的類型。

傳回

Promise<Attachment[]>

getBadge(string, number, string)

取得徽章，指出定義的最新組建狀態。請注意，此 API 已被取代。偏好 StatusBadgeController.GetStatusBadge。

function getBadge(project: string, definitionId: number, branchName?: string): Promise<string>

參數

project: string

專案識別碼或名稱。

definitionId: number

定義的識別碼。

branchName: string

分支的名稱。

傳回

Promise<string>

getBuild(string, number, string)

取得組建

function getBuild(project: string, buildId: number, propertyFilters?: string): Promise<Build>

參數

project: string

專案識別碼或專案名稱

buildId: number

propertyFilters: string

傳回

Promise<Build>

getBuildBadge(string, string, string, string)

取得徽章，指出指定分支的最新組建狀態。

function getBuildBadge(project: string, repoType: string, repoId?: string, branchName?: string): Promise<BuildBadge>

參數

project: string

專案識別碼或專案名稱

repoType: string

存放庫類型。

repoId: string

存放庫識別碼。

branchName: string

分支名稱。

傳回

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

取得徽章，指出指定分支的最新組建狀態。

function getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>

參數

project: string

專案識別碼或專案名稱

repoType: string

存放庫類型。

repoId: string

存放庫識別碼。

branchName: string

分支名稱。

傳回

Promise<string>

getBuildChanges(string, number, string, number, boolean)

取得與組建相關聯的變更

function getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<PagedList<Change>>

參數

project: string

專案識別碼或專案名稱

buildId: number

continuationToken: string

top: number

要傳回的變更數目上限

includeSourceChange: boolean

傳回

Promise<PagedList<Change>>

getBuildController(number)

取得控制器

function getBuildController(controllerId: number): Promise<BuildController>

參數

controllerId: number

傳回

Promise<BuildController>

getBuildControllers(string)

取得控制器，選擇性地依名稱篩選

function getBuildControllers(name?: string): Promise<BuildController[]>

參數

name: string

傳回

Promise<BuildController[]>

getBuildGeneralSettings(string)

取得管線一般設定。

function getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>

參數

project: string

專案識別碼或專案名稱

傳回

Promise<PipelineGeneralSettings>

getBuildLog(string, number, number, number, number)

取得組建的個別記錄檔。

function getBuildLog(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

logId: number

記錄檔的識別碼。

startLine: number

起始行。

endLine: number

結尾行。

傳回

Promise<string>

getBuildLogLines(string, number, number, number, number)

取得組建的個別記錄檔。

function getBuildLogLines(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

logId: number

記錄檔的識別碼。

startLine: number

起始行。

endLine: number

結尾行。

傳回

Promise<string[]>

getBuildLogs(string, number)

取得組建的記錄。

function getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<BuildLog[]>

getBuildLogsZip(string, number)

取得組建的記錄。

function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<ArrayBuffer>

getBuildLogZip(string, number, number, number, number)

取得組建的個別記錄檔。

function getBuildLogZip(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<ArrayBuffer>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

logId: number

記錄檔的識別碼。

startLine: number

起始行。

endLine: number

結尾行。

傳回

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

取得系統支援的所有組建定義選項。

function getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>

參數

project: string

專案識別碼或專案名稱

傳回

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

取得組建的屬性。

function getBuildProperties(project: string, buildId: number, filter?: string[]): Promise<any>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

filter: string[]

以逗號分隔的屬性清單。如果指定，則會篩選這些特定屬性。

傳回

Promise<any>

getBuildReport(string, number, string)

取得組建報表。

function getBuildReport(project: string, buildId: number, type?: string): Promise<BuildReportMetadata>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

type: string

傳回

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

取得組建報表。

function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

type: string

傳回

Promise<any>

getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)

取得組建清單。

function getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: BuildReason, statusFilter?: BuildStatus, resultFilter?: BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: QueryDeletedOption, queryOrder?: BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<PagedList<Build>>

參數

project: string

專案識別碼或專案名稱

definitions: number[]

以逗號分隔的定義識別碼清單。如果已指定，則會篩選這些定義的組建。

queues: number[]

以逗號分隔的佇列識別碼清單。如果指定，則會篩選針對這些佇列執行的組建。

buildNumber: string

如果指定，則會篩選符合此組建編號的組建。附加 * 以執行前置詞搜尋。

minTime: Date

如果指定，則會根據指定的 queryOrder，篩選以建置在此日期之後完成/啟動/排入佇列的組建。

maxTime: Date

如果指定，則會根據指定的 queryOrder，篩選以建置完成/啟動/排入此日期之前的組建。

requestedFor: string

如果指定，則會篩選為指定使用者要求的組建。

reasonFilter: BuildReason

如果指定，則會篩選為符合此原因的組建。

statusFilter: BuildStatus

如果指定，則會篩選符合此狀態的組建。

resultFilter: BuildResult

如果指定，則會篩選符合此結果的組建。

tagFilters: string[]

以逗號分隔的標記清單。如果指定，則會篩選具有指定標籤的組建。

properties: string[]

要擷取的屬性逗號分隔清單。

top: number

要傳回的組建數目上限。

continuationToken: string

先前呼叫這個方法所傳回的接續權杖，可用來傳回下一組組建。

maxBuildsPerDefinition: number

每個定義要傳回的組建數目上限。

deletedFilter: QueryDeletedOption

指出是否要排除、包含或只傳回已刪除的組建。

queryOrder: BuildQueryOrder

應該傳回組建的順序。

branchName: string

如果指定，篩選以建置建置此分支的分支。

buildIds: number[]

以逗號分隔的清單，指定要擷取之組建的識別碼。

repositoryId: string

如果指定，則會篩選從這個存放庫建置的組建。

repositoryType: string

如果指定，則會篩選從此類型的存放庫建置的組建。

傳回

Promise<PagedList<Build>>

getBuildSettings(string)

取得組建設定。

function getBuildSettings(project?: string): Promise<BuildSettings>

參數

project: string

專案識別碼或專案名稱

傳回

Promise<BuildSettings>

getBuildTags(string, number)

取得組建的標記。

function getBuildTags(project: string, buildId: number): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<string[]>

getBuildTimeline(string, number, string, number, string)

取得組建的詳細資料

function getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise<Timeline>

參數

project: string

專案識別碼或專案名稱

buildId: number

timelineId: string

changeId: number

planId: string

傳回

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

取得與組建相關聯的工作專案。只會傳回相同專案中的工作專案。

function getBuildWorkItemsRefs(project: string, buildId: number, top?: number): Promise<ResourceRef[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

top: number

要傳回的工作專案數目上限。

傳回

Promise<ResourceRef[]>

getBuildWorkItemsRefsFromCommits(string[], string, number, number)

取得與組建相關聯的工作專案，篩選為特定認可。

function getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise<ResourceRef[]>

參數

commitIds: string[]

以逗號分隔的認可識別碼清單。

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

top: number

要傳回的工作專案數目上限，或未指定認可識別碼時要考慮的認可數目。

傳回

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

取得在兩個指定組建之間對存放庫所做的變更。

function getChangesBetweenBuilds(project: string, fromBuildId?: number, toBuildId?: number, top?: number): Promise<Change[]>

參數

project: string

專案識別碼或專案名稱

fromBuildId: number

第一個組建的識別碼。

toBuildId: number

最後一個組建的識別碼。

top: number

要傳回的變更數目上限。

傳回

Promise<Change[]>

getDefinition(string, number, number, Date, string[], boolean)

取得定義，選擇性地在特定修訂中。

function getDefinition(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<BuildDefinition>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

revision: number

要擷取的修訂編號。如果未指定此專案，則會傳回最新版本。

minMetricsTime: Date

如果指定，表示應該包含計量的日期。

propertyFilters: string[]

要包含在結果中的屬性逗號分隔清單。

includeLatestBuilds: boolean

傳回

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

取得定義的建置計量。

function getDefinitionMetrics(project: string, definitionId: number, minMetricsTime?: Date): Promise<BuildMetric[]>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

minMetricsTime: Date

要計算計量的日期。

傳回

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

取得定義的屬性。

function getDefinitionProperties(project: string, definitionId: number, filter?: string[]): Promise<any>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

filter: string[]

以逗號分隔的屬性清單。如果指定，請篩選至這些特定屬性。

傳回

Promise<any>

getDefinitionResources(string, number)

function getDefinitionResources(project: string, definitionId: number): Promise<DefinitionResourceReference[]>

參數

project: string

專案識別碼或專案名稱

definitionId: number

傳回

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

取得定義的所有修訂。

function getDefinitionRevisions(project: string, definitionId: number): Promise<BuildDefinitionRevision[]>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

傳回

Promise<BuildDefinitionRevision[]>

getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)

取得定義清單。

function getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: DefinitionQueryOrder, top?: number, continuationToken?: string, minMetricsTime?: Date, definitionIds?: number[], path?: string, builtAfter?: Date, notBuiltAfter?: Date, includeAllProperties?: boolean, includeLatestBuilds?: boolean, taskIdFilter?: string, processType?: number, yamlFilename?: string): Promise<PagedList<BuildDefinitionReference>>

參數

project: string

專案識別碼或專案名稱

name: string

如果指定，請篩選為名稱符合此模式的定義。

repositoryId: string

存放庫識別碼。如果指定，請篩選使用此存放庫的定義。

repositoryType: string

如果指定，請篩選具有此類型存放庫的定義。

queryOrder: DefinitionQueryOrder

指出應該傳回定義的順序。

top: number

要傳回的定義數目上限。

continuationToken: string

先前呼叫這個方法所傳回的接續權杖，可用來傳回下一組定義。

minMetricsTime: Date

如果指定，表示應該包含計量的日期。

definitionIds: number[]

以逗號分隔的清單，指定要擷取的定義識別碼。

path: string

如果指定，請篩選此資料夾底下的定義。

builtAfter: Date

如果指定，請篩選到在此日期之後具有組建的定義。

notBuiltAfter: Date

如果指定，篩選到在此日期之後沒有組建的定義。

includeAllProperties: boolean

指出是否應該傳回完整定義。根據預設，會傳回定義的淺層標記法。

includeLatestBuilds: boolean

指出是否傳回此定義的最新和最新已完成組建。

taskIdFilter: string

如果指定，則會篩選為使用指定工作的定義。

processType: number

如果指定，則會篩選為具有指定進程類型的定義。

yamlFilename: string

如果指定，則會篩選符合指定檔案名的 YAML 定義。若要使用此篩選 includeAllProperties，應設定為 true

傳回

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

取得定義的標記。

function getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

revision: number

定義修訂編號。如果未指定，請使用定義的最新修訂。

傳回

Promise<string[]>

getDefinitionYaml(string, number, number, Date, string[], boolean)

選擇性地在特定修訂中，將定義轉換為 YAML。

function getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<YamlBuild>

參數

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

revision: number

要擷取的修訂編號。如果未指定此專案，則會傳回最新版本。

minMetricsTime: Date

如果指定，表示應該包含計量的日期。

propertyFilters: string[]

要包含在結果中的屬性逗號分隔清單。

includeLatestBuilds: boolean

傳回

Promise<YamlBuild>

getFile(string, number, string, string, string)

從組建取得檔案。

function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

artifactName: string

成品的名稱。

fileId: string

檔案的主鍵。

fileName: string

檔案將設定為的名稱。

傳回

Promise<ArrayBuffer>

getFileContents(string, string, string, string, string, string)

取得指定原始程式碼存放庫中檔案的內容。

function getFileContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<string>

參數

project: string

專案識別碼或專案名稱

providerName: string

來源提供者的名稱。

serviceEndpointId: string

如果指定，則為要查詢之服務端點的識別碼。只能省略未使用服務端點的提供者，例如 TFVC 或 TFGit。

repository: string

如果指定，則為廠商特定的識別碼或要取得分支的存放庫名稱。只能省略不支援多個存放庫的提供者。

commitOrBranch: string

擷取檔案內容之認可或分支的識別碼。

path: string

要擷取之檔案的路徑，相對於存放庫的根目錄。

傳回

Promise<string>

getFolders(string, string, FolderQueryOrder)

取得組建定義資料夾的清單。

function getFolders(project: string, path?: string, queryOrder?: FolderQueryOrder): Promise<Folder[]>

參數

project: string

專案識別碼或專案名稱

path: string

要開頭的路徑。

queryOrder: FolderQueryOrder

應該傳回資料夾的順序。

傳回

Promise<Folder[]>

getLatestBuild(string, string, string)

取得定義的最新組建，選擇性地限定為特定分支。

function getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build>

參數

project: string

專案識別碼或專案名稱

definition: string

具有選擇性前置資料夾路徑或定義識別碼的定義名稱

branchName: string

選擇性參數，指出要使用的特定分支。如果未指定，則會使用預設分支。

傳回

Promise<Build>

getPathContents(string, string, string, string, string, string)

取得指定原始程式碼存放庫中目錄的內容。

function getPathContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<SourceRepositoryItem[]>

參數

project: string

專案識別碼或專案名稱

providerName: string

來源提供者的名稱。

serviceEndpointId: string

如果指定，則為要查詢之服務端點的識別碼。只能省略未使用服務端點的提供者，例如 TFVC 或 TFGit。

repository: string

如果指定，則為廠商特定的識別碼或要取得分支的存放庫名稱。只能省略不支援多個存放庫的提供者。

commitOrBranch: string

擷取檔案內容之認可或分支的識別碼。

path: string

要列出的路徑內容，相對於存放庫的根目錄。

傳回

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

取得專案的建置計量。

function getProjectMetrics(project: string, metricAggregationType?: string, minMetricsTime?: Date): Promise<BuildMetric[]>

參數

project: string

專案識別碼或專案名稱

metricAggregationType: string

每小時、每日) (使用的匯總類型。

minMetricsTime: Date

要計算計量的日期。

傳回

Promise<BuildMetric[]>

getProjectResources(string, string, string)

function getProjectResources(project: string, type?: string, id?: string): Promise<DefinitionResourceReference[]>

參數

project: string

專案識別碼或專案名稱

type: string

id: string

傳回

Promise<DefinitionResourceReference[]>

getPullRequest(string, string, string, string, string)

從來源提供者取得提取要求物件。

function getPullRequest(project: string, providerName: string, pullRequestId: string, repositoryId?: string, serviceEndpointId?: string): Promise<PullRequest>

參數

project: string

專案識別碼或專案名稱

providerName: string

來源提供者的名稱。

pullRequestId: string

提取要求的廠商特定識別碼。

repositoryId: string

廠商特定的識別碼或包含提取要求的存放庫名稱。

serviceEndpointId: string

如果指定，則為要查詢之服務端點的識別碼。只能省略未使用服務端點的提供者，例如 TFVC 或 TFGit。

傳回

Promise<PullRequest>

getResourceUsage()

取得系統中建置資源的相關資訊。

function getResourceUsage(): Promise<BuildResourceUsage>

傳回

Promise<BuildResourceUsage>

getRetentionHistory(number)

傳回專案集合的保留歷程記錄。這包括具有自訂保留規則的管線，這些規則可能會防止保留作業清除、每個管線執行，其中包含保留類型、與具有保留類型之集合所擁有的管線相關聯的檔案，以及每個管線的檔案數目。

function getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>

參數

daysToLookback: number

傳回

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

傳回指定租用識別碼的保留租用詳細資料。

function getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>

參數

project: string

專案識別碼或專案名稱

leaseId: number

傳回

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

傳回符合指定之 MinimalRetentionLeases 的任何租用

function getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: MinimalRetentionLease[]): Promise<RetentionLease[]>

參數

project: string

專案識別碼或專案名稱

leasesToFetch: MinimalRetentionLease[]

以 '|' 分隔的 JSON 序列化 MinimalRetentionLeases 清單

傳回

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

傳回指定實體所擁有的任何租用，選擇性地限定為單一管線定義並執行。

function getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

參數

project: string

專案識別碼或專案名稱

ownerId: string

definitionId: number

選擇性參數，可限制搜尋至特定的管線定義。

runId: number

選擇性參數，將搜尋限制為單一管線執行。需要 definitionId。

傳回

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

傳回指定使用者所擁有的任何租用，選擇性地限定為單一管線定義並執行。

function getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

參數

project: string

專案識別碼或專案名稱

userOwnerId: string

要搜尋的使用者識別碼。

definitionId: number

選擇性參數，可限制搜尋至特定的管線定義。

runId: number

選擇性參數，將搜尋限制為單一管線執行。需要 definitionId。

傳回

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

取得套用至特定組建的所有保留租用。

function getRetentionLeasesForBuild(project: string, buildId: number): Promise<RetentionLease[]>

參數

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<RetentionLease[]>

getRetentionSettings(string)

取得專案的保留設定。

function getRetentionSettings(project: string): Promise<ProjectRetentionSetting>

參數

project: string

專案識別碼或專案名稱

傳回

Promise<ProjectRetentionSetting>

getStatusBadge(string, string, string, string, string, string, string)

<p > 取得定義的組建狀態，選擇性地限定為特定分支、階段、作業和組態。 </p p ><> 如果有多個，則在指定 jobName 時需要傳入 stageName 值，而且如果傳遞組態參數，則會套用相同的規則。 </P>

function getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise<string>

參數

project: string

專案識別碼或專案名稱

definition: string

具有選擇性前置資料夾路徑的定義名稱或定義識別碼。

branchName: string

只考慮此分支的最新組建。如果未指定，則會使用預設分支。

stageName: string

在管線內使用此階段來呈現狀態。

jobName: string

在管線的階段內使用此作業來呈現狀態。

configuration: string

使用此作業組態來轉譯狀態

label: string

取代徽章左側的預設文字。

傳回

Promise<string>

getTags(string)

取得專案中所有建置標記的清單。

function getTags(project: string): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

傳回

Promise<string[]>

getTemplate(string, string)

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

function getTemplate(project: string, templateId: string): Promise<BuildDefinitionTemplate>

參數

project: string

專案識別碼或專案名稱

templateId: string

要求的範本識別碼。

傳回

Promise<BuildDefinitionTemplate>

getTemplates(string)

取得所有定義範本。

function getTemplates(project: string): Promise<BuildDefinitionTemplate[]>

參數

project: string

專案識別碼或專案名稱

傳回

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

取得兩個組建之間的所有工作專案。

function getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<ResourceRef[]>

參數

project: string

專案識別碼或專案名稱

fromBuildId: number

第一個組建的識別碼。

toBuildId: number

最後一個組建的識別碼。

top: number

要傳回的工作專案數目上限。

傳回

Promise<ResourceRef[]>

listBranches(string, string, string, string, string)

取得指定原始程式碼存放庫的分支清單。

function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: string): Promise<string[]>

參數

project: string

專案識別碼或專案名稱

providerName: string

來源提供者的名稱。

serviceEndpointId: string

如果指定，則為要查詢之服務端點的識別碼。只能省略未使用服務端點的提供者，例如 TFVC 或 TFGit。

repository: string

要取得分支的廠商特定識別碼或存放庫名稱。只能省略不支援多個存放庫的提供者。

branchName: string

如果提供，要特別檢查的分支名稱。

傳回

Promise<string[]>

listRepositories(string, string, string, string, ResultSet, boolean, string)

取得原始程式碼存放庫的清單。

function listRepositories(project: string, providerName: string, serviceEndpointId?: string, repository?: string, resultSet?: ResultSet, pageResults?: boolean, continuationToken?: string): Promise<SourceRepositories>

參數

project: string

專案識別碼或專案名稱

providerName: string

來源提供者的名稱。

serviceEndpointId: string

如果指定，則為要查詢之服務端點的識別碼。只能省略未使用服務端點的提供者，例如 TFVC 或 TFGit。

repository: string

如果指定，廠商特定的識別碼或要取得的單一存放庫名稱。

resultSet: ResultSet

與端點最相關的存放庫'top'。如果未設定，則會傳回所有存放庫。如果已設定 'repository'，則會忽略。

pageResults: boolean

如果設定為 true，這會限制結果集，並傳回接續權杖以繼續查詢。

continuationToken: string

分頁結果時，這是先前呼叫此方法所傳回的接續權杖，可用來傳回下一組存放庫。

傳回

Promise<SourceRepositories>

listSourceProviders(string)

取得來源提供者及其功能的清單。

function listSourceProviders(project: string): Promise<SourceProviderAttributes[]>

參數

project: string

專案識別碼或專案名稱

傳回

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

取得指定原始程式碼存放庫中安裝的 Webhook 清單。

function listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<RepositoryWebhook[]>

參數

project: string

專案識別碼或專案名稱

providerName: string

來源提供者的名稱。

serviceEndpointId: string

如果指定，則為要查詢之服務端點的識別碼。只能省略未使用服務端點的提供者，例如 TFVC 或 TFGit。

repository: string

如果指定，則為廠商特定的識別碼或存放庫名稱，以取得 Webhook。只能省略不支援多個存放庫的提供者。

傳回

Promise<RepositoryWebhook[]>

queueBuild(Build, string, boolean, string, number, number)

將組建排入佇列

function queueBuild(build: Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build>

參數

build: Build

project: string

專案識別碼或專案名稱

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

選擇性定義識別碼，以將組建排入佇列，而不需主體。如果有有效的本文，則會忽略

傳回

Promise<Build>

restoreDefinition(string, number, boolean)

還原已刪除的定義

function restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<BuildDefinition>

參數

project: string

專案識別碼或專案名稱

definitionId: number

要還原的定義識別碼。

deleted: boolean

如果為 false，則會還原已刪除的定義。

傳回

Promise<BuildDefinition>

restoreWebhooks(DefinitionTriggerType[], string, string, string, string)

為指定原始程式碼存放庫中的指定觸發程式重新建立 Webhook。

function restoreWebhooks(triggerTypes: DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<void>

參數

triggerTypes: DefinitionTriggerType[]

要還原 Webhook 的觸發程式類型。

project: string

專案識別碼或專案名稱

providerName: string

來源提供者的名稱。

serviceEndpointId: string

如果指定，則為要查詢之服務端點的識別碼。只能省略未使用服務端點的提供者，例如 TFVC 或 TFGit。

repository: string

如果指定，則為廠商特定的識別碼或存放庫名稱，以取得 Webhook。只能省略不支援多個存放庫的提供者。

傳回

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

更新現有的組建定義範本。

function saveTemplate(template: BuildDefinitionTemplate, project: string, templateId: string): Promise<BuildDefinitionTemplate>

參數

template: BuildDefinitionTemplate

新版的範本。

project: string

專案識別碼或專案名稱

templateId: string

範本的識別碼。

傳回

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

更新組建。

function updateBuild(build: Build, project: string, buildId: number, retry?: boolean): Promise<Build>

參數

build: Build

組建。

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

retry: boolean

傳回

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

更新管線一般設定。

function updateBuildGeneralSettings(newSettings: PipelineGeneralSettings, project: string): Promise<PipelineGeneralSettings>

參數

newSettings: PipelineGeneralSettings

project: string

專案識別碼或專案名稱

傳回

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

更新組建的屬性。

function updateBuildProperties(document: JsonPatchDocument, project: string, buildId: number): Promise<any>

參數

document: JsonPatchDocument

描述要更新之屬性的 json 修補檔。

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<any>

updateBuilds(Build[], string)

更新多個組建。

function updateBuilds(builds: Build[], project: string): Promise<Build[]>

參數

builds: Build[]

要更新的組建。

project: string

專案識別碼或專案名稱

傳回

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

更新組建設定。

function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>

參數

settings: BuildSettings

新的設定。

project: string

專案識別碼或專案名稱

傳回

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

從組建新增/移除標記。

function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>

參數

updateParameters: UpdateTagParameters

要新增/移除的標記。

project: string

專案識別碼或專案名稱

buildId: number

組建的識別碼。

傳回

Promise<string[]>

updateDefinition(BuildDefinition, string, number, number, number)

更新現有的組建定義。為了讓此作業成功，要求主體的「Revision」屬性值必須符合現有的組建定義。建議您使用 GET 取得現有的組建定義、視需要修改組建定義，然後使用 PUT 提交修改的定義。

function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number): Promise<BuildDefinition>

參數

definition: BuildDefinition

新版的定義。其「Revision」屬性必須符合要接受之更新的現有定義。

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

傳回

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

更新定義的屬性。

function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>

參數

document: JsonPatchDocument

描述要更新之屬性的 json 修補檔。

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

傳回

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

從定義新增/移除標記。

function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>

參數

updateParameters: UpdateTagParameters

要新增/移除的標記。

project: string

專案識別碼或專案名稱

definitionId: number

定義的識別碼。

傳回

Promise<string[]>

updateFolder(Folder, string, string)

更新位於指定現有路徑的現有資料夾

function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>

參數

folder: Folder

新版的資料夾。

project: string

專案識別碼或專案名稱

path: string

資料夾的完整路徑。

傳回

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

更新保留租用的持續時間或管線保護狀態。

function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>

參數

leaseUpdate: RetentionLeaseUpdate

保留租用的新資料。

project: string

專案識別碼或專案名稱

leaseId: number

要更新之租用的識別碼。

傳回

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

更新專案的保留設定。

function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>

參數

updateModel: UpdateProjectRetentionSettingModel

project: string

專案識別碼或專案名稱

傳回

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

更新組建階段

function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>

參數

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

專案識別碼或專案名稱

傳回

Promise<void>

共用方式為

BuildRestClient class

建構函式

屬性

方法

建構函式詳細資料

BuildRestClient(IVssRestClientOptions)

參數

屬性詳細資料

RESOURCE_AREA_ID

屬性值

方法詳細資料

addBuildTag(string, number, string)

參數

傳回

addBuildTags(string[], string, number)

參數

傳回

addDefinitionTag(string, number, string)

參數

傳回

addDefinitionTags(string[], string, number)

參數

傳回

addRetentionLeases(NewRetentionLease[], string)

參數

傳回

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

參數

傳回

authorizeProjectResources(DefinitionResourceReference[], string)

參數

傳回

createArtifact(BuildArtifact, string, number)

參數

傳回

createDefinition(BuildDefinition, string, number, number)

參數

傳回

createFolder(Folder, string, string)

參數

傳回

deleteBuild(string, number)

參數

傳回

deleteBuildTag(string, number, string)

參數

傳回

deleteDefinition(string, number)

參數

傳回

deleteDefinitionTag(string, number, string)

參數

傳回

deleteFolder(string, string)

參數

傳回

deleteRetentionLeasesById(string, number[])

參數

傳回

deleteTag(string, string)

參數

傳回

deleteTemplate(string, string)

參數

傳回

getArtifact(string, number, string)

參數

傳回

getArtifactContentZip(string, number, string)

參數

傳回

getArtifacts(string, number)

參數

傳回

getAttachment(string, number, string, string, string, string)

參數

傳回

getAttachments(string, number, string)

參數