BuildRestClient class

new BuildRestClient(options: IVssRestClientOptions)

參數

static RESOURCE_AREA_ID: "965220d5-5bb9-42cf-8d67-9b146df2a5a4" = "965220d5-5bb9-42cf-8d67-9b146df2a5a4"

屬性值

為建構加上標籤。

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

參數

傳回

為流派加上標籤。

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

參數

傳回

將標籤新增至定義

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

參數

傳回

在定義中加入多個標籤。

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

參數

傳回

新增管線營運的租約。

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

參數

傳回

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

參數

傳回

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

參數

傳回

將神器與出裝連結起來。

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

參數

傳回

建立新的定義。

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

參數

傳回

建立新資料夾。

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

參數

傳回

刪除組建。

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

參數

傳回

移除一個角色配置中的標籤。 注意：此 API 無法用於帶有特殊字元的標籤。 若要移除帶有特殊字元的標籤，請使用 PATCH 方法（在 6.0+ 版本中）

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

參數

傳回

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

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

參數

傳回

移除定義中的標籤。 注意：此 API 無法用於帶有特殊字元的標籤。 若要移除帶有特殊字元的標籤，請使用 PATCH 方法（在 6.0+ 版本中）

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

參數

傳回

刪除一個定義資料夾。 定義及其對應的配置也會被刪除。

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

參數

傳回

移除特定的保留租約。

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

參數

傳回

從建置、定義以及標籤商店移除標籤

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

參數

傳回

刪除一個建置定義範本。

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

參數

傳回

為一個流派獲得特定神器。

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

參數

傳回

為一個流派獲得特定神器。

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

參數

傳回

收集所有神器以配合建構。

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

參數

傳回

有特定的依附。

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

參數

傳回

取得與該建構相關的特定類型的附件清單。

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

參數

傳回

會獲得一個徽章，顯示最新版本的狀態以便定義。 請注意，此 API 已被棄用。 偏好 StatusBadgeController.GetStatusBadge.

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

參數

傳回

取得組建

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

參數

傳回

會獲得一個徽章，顯示該分支最新版本的狀態。

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

參數

傳回

會獲得一個徽章，顯示該分支最新版本的狀態。

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

參數

傳回

取得與建構相關的變更

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

參數

傳回

拿到控制器

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

參數

傳回

取得控制器，可依名稱篩選

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

參數

傳回

取得管線一般設定。

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

參數

傳回

會取得一個獨立的日誌檔來執行建置。

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

參數

傳回

會取得一個獨立的日誌檔來執行建置。

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

參數

傳回

取得建造所需的日誌。

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

參數

傳回

取得建造所需的日誌。

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

參數

傳回

會取得一個獨立的日誌檔來執行建置。

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

參數

傳回

系統支援的所有建置定義選項。

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

參數

傳回

取得建構用的屬性。

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

參數

傳回

會收到建置報告。

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

參數

傳回

會收到建置報告。

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

參數

傳回

取得組建清單。

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

參數

傳回

取得建造設定。

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

參數

傳回

能取得一個建構的最新時間軸，篩選到特定階段。

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

參數

傳回

讓建構的時間軸被篩選到特定階段。

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

參數

傳回

拿到角色配置的標籤。

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

參數

傳回

取得建造細節

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

參數

傳回

取得與建構相關的工作項目。 只有同一專案中的工作項目會被退回。

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

參數

傳回

取得與建置相關的工作項目，並篩選到特定提交。

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

參數

傳回

讀取兩個給定建置間對倉庫所做的變更。

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

參數

傳回

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

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

參數

傳回

取得建構指標以建立定義。

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

參數

傳回

取得定義性質。

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

參數

傳回

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

參數

傳回

取得所有定義的修訂。

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

參數

傳回

取得定義清單。

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

參數

傳回

取得標籤以取得定義。

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

參數

傳回

可選擇在特定版本時將定義轉換為 YAML。

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

參數

傳回

從建置過程中取得檔案。

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

參數

傳回

取得給定原始碼倉庫中檔案的內容。

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

參數

傳回

會取得一個建置定義資料夾清單。

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

參數

傳回

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

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

參數

傳回

取得該原始碼倉庫目錄的內容。

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

參數

傳回

取得專案的建置指標。

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

參數

傳回

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

參數

傳回

會從來源提供者取得一個拉取請求物件。

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

參數

傳回

獲取系統中建造資源的資訊。

function getResourceUsage(): Promise<BuildResourceUsage>

傳回

回傳專案收藏的保留歷史。 這包括具有自訂保留規則的管線，可能阻止保留工作清理這些規則、每個具有保留類型的管線執行、集合擁有保留類型的管線相關檔案，以及每個管線的檔案數量。

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

參數

傳回

回傳保留租約的詳細資料並附上租約編號。

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

參數

傳回

回傳符合指定最低保留租約的租約

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

參數

傳回

回傳指定實體擁有的任何租約，並可選擇性地設定單一管線定義並執行。

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

參數

傳回

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

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

參數

傳回

負責所有適用於特定建築的保留租約。

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

參數

傳回

取得專案的保留設定。

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

參數

傳回

<p>取得定義的建置狀態，可選擇性地限定於特定分支、階段、工作及組態。</p><p>如果有多個，則在指定 jobName 時必須傳遞 stageName 值，而在傳遞設定參數時，兩者皆適用相同的規則。</p>

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

參數

傳回

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

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

參數

傳回

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

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

參數

傳回

取得所有定義範本。

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

參數

傳回

在兩個建造之間取得所有工作項目。

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

參數

傳回

會獲得該原始碼倉庫的分支清單。

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

參數

傳回

會拿到原始碼倉庫清單。

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

參數

傳回

取得來源供應商及其能力清單。

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

參數

傳回

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

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

參數

傳回

將組建排入佇列

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

參數

傳回

還原已刪除的定義

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

參數

傳回

在指定的原始碼倉庫中重新建立指定的觸發器 webhook。

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

參數

傳回

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

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

參數

傳回

更新組建。

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

參數

傳回

更新管線一般設定。

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

參數

傳回

更新建置的屬性。

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

參數

傳回

更新多個組建。

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

參數

傳回

更新建構設定。

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

參數

傳回

新增或移除一個角色配置中的標籤。

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

參數

傳回

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

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

參數

傳回

更新定義屬性。

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

參數

傳回

新增或移除定義中的標籤。

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

參數

傳回

在指定路徑更新現有資料夾

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

參數

傳回

更新保留租約的期限或管線保護狀態。

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

參數

傳回

更新專案的保留設定。

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

參數

傳回

更新建置階段

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

參數

傳回