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)	임대 ID가 지정된 보존 임대의 세부 정보를 반환합니다.
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)	지정된 소스 코드 리포지토리에 설치된 웹후크 목록을 가져옵니다.
queueBuild(Build, string, boolean, string, number, number)	빌드 큐
restoreDefinition(string, number, boolean)	삭제된 정의를 복원합니다.
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	지정된 소스 코드 리포지토리에서 지정된 트리거에 대한 웹후크를 다시 만듭니다.
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

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

tag: string

추가할 태그입니다.

반환

Promise<string[]>

addBuildTags(string[], string, number)

빌드에 태그를 추가합니다.

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

매개 변수

tags: string[]

추가할 태그입니다. 요청 본문은 나열된 태그에서 직접 구성됩니다.

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

Promise<string[]>

addDefinitionTag(string, number, string)

정의에 태그 추가

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

tag: string

추가할 태그입니다.

반환

Promise<string[]>

addDefinitionTags(string[], string, number)

정의에 여러 태그를 추가합니다.

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

매개 변수

tags: string[]

추가할 태그입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

반환

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

파이프라인 실행에 대한 새 임대를 추가합니다.

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

매개 변수

newLeases: NewRetentionLease[]

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

매개 변수

resources: DefinitionResourceReference[]

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

반환

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

매개 변수

resources: DefinitionResourceReference[]

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

아티팩트를 빌드와 연결합니다.

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

매개 변수

artifact: BuildArtifact

아티팩트입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

새 정의를 만듭니다.

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

매개 변수

definition: BuildDefinition

정의입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

definitionToCloneId: number

definitionToCloneRevision: number

반환

Promise<BuildDefinition>

createFolder(Folder, string, string)

새 폴더를 만듭니다.

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

매개 변수

folder: Folder

폴더입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

path: string

폴더의 전체 경로입니다.

반환

Promise<Folder>

deleteBuild(string, number)

빌드를 삭제합니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

Promise<void>

deleteBuildTag(string, number, string)

빌드에서 태그를 제거합니다. 참고: 이 API는 특수 문자가 있는 태그에는 작동하지 않습니다. 특수 문자가 있는 태그를 제거하려면 PATCH 메서드를 대신 사용합니다(6.0 이상).

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

tag: string

제거할 태그입니다.

반환

Promise<string[]>

deleteDefinition(string, number)

정의 및 연결된 모든 빌드를 삭제합니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

반환

Promise<void>

deleteDefinitionTag(string, number, string)

정의에서 태그를 제거합니다. 참고: 이 API는 특수 문자가 있는 태그에는 작동하지 않습니다. 특수 문자가 있는 태그를 제거하려면 PATCH 메서드를 대신 사용합니다(6.0 이상).

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

tag: string

제거할 태그입니다.

반환

Promise<string[]>

deleteFolder(string, string)

정의 폴더를 삭제합니다. 정의 및 해당 빌드도 삭제됩니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

path: string

폴더의 전체 경로입니다.

반환

Promise<void>

deleteRetentionLeasesById(string, number[])

특정 보존 임대를 제거합니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

ids: number[]

반환

Promise<void>

deleteTag(string, string)

빌드, 정의 및 태그 저장소에서 태그를 제거합니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

tag: string

제거할 태그입니다.

반환

Promise<string[]>

deleteTemplate(string, string)

빌드 정의 템플릿을 삭제합니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

templateId: string

템플릿의 ID입니다.

반환

Promise<void>

getArtifact(string, number, string)

빌드에 대한 특정 아티팩트 가져오기

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

artifactName: string

아티팩트 이름입니다.

반환

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

빌드에 대한 특정 아티팩트 가져오기

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

artifactName: string

아티팩트 이름입니다.

반환

Promise<ArrayBuffer>

getArtifacts(string, number)

빌드에 대한 모든 아티팩트 가져오기

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

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

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

timelineId: string

타임라인 ID입니다.

recordId: string

타임라인 레코드의 ID입니다.

type: string

첨부 파일의 형식입니다.

name: string

첨부 파일의 이름입니다.

반환

Promise<ArrayBuffer>

getAttachments(string, number, string)

빌드와 연결된 특정 형식의 첨부 파일 목록을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

type: string

첨부 파일의 형식입니다.

반환

Promise<Attachment[]>

getBadge(string, number, string)

정의에 대한 최신 빌드의 상태 나타내는 배지를 가져옵니다. 이 API는 더 이상 사용되지 않습니다. StatusBadgeController.GetStatusBadge를 선호합니다.

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

매개 변수

project: string

프로젝트 ID 또는 이름입니다.

definitionId: number

정의의 ID입니다.

branchName: string

분기의 이름입니다.

반환

Promise<string>

getBuild(string, number, string)

빌드 가져오기

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

repoType: string

리포지토리 형식입니다.

repoId: string

리포지토리 ID입니다.

branchName: string

분기 이름입니다.

반환

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

지정된 분기에 대한 가장 최근 빌드의 상태 나타내는 배지를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

repoType: string

리포지토리 형식입니다.

repoId: string

리포지토리 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

반환

Promise<PipelineGeneralSettings>

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

빌드에 대한 개별 로그 파일을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

logId: number

로그 파일의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

logId: number

로그 파일의 ID입니다.

startLine: number

시작 줄.

endLine: number

끝 줄입니다.

반환

Promise<string[]>

getBuildLogs(string, number)

빌드에 대한 로그를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

Promise<BuildLog[]>

getBuildLogsZip(string, number)

빌드에 대한 로그를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

Promise<ArrayBuffer>

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

빌드에 대한 개별 로그 파일을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

logId: number

로그 파일의 ID입니다.

startLine: number

시작 줄.

endLine: number

끝 줄입니다.

반환

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

시스템에서 지원하는 모든 빌드 정의 옵션을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

빌드의 속성을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

filter: string[]

쉼표로 구분된 속성 목록입니다. 지정된 경우 이러한 특정 속성으로 필터링합니다.

반환

Promise<any>

getBuildReport(string, number, string)

빌드 보고서를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

type: string

반환

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

빌드 보고서를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

definitions: number[]

쉼표로 구분된 정의 ID 목록입니다. 지정된 경우 이러한 정의에 대한 빌드를 필터링합니다.

queues: number[]

쉼표로 구분된 큐 ID 목록입니다. 지정된 경우 이러한 큐에 대해 실행된 빌드를 필터링합니다.

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

검색할 빌드의 ID를 지정하는 쉼표로 구분된 목록입니다.

repositoryId: string

지정된 경우 이 리포지토리에서 빌드된 빌드를 필터링합니다.

repositoryType: string

지정된 경우 이 형식의 리포지토리에서 빌드된 빌드를 필터링합니다.

반환

Promise<PagedList<Build>>

getBuildSettings(string)

빌드 설정을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<BuildSettings>

getBuildTags(string, number)

빌드의 태그를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

Promise<string[]>

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

빌드에 대한 세부 정보를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

top: number

반환할 최대 작업 항목 수입니다.

반환

Promise<ResourceRef[]>

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

특정 커밋으로 필터링된 빌드와 연결된 작업 항목을 가져옵니다.

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

매개 변수

commitIds: string[]

커밋 ID의 쉼표로 구분된 목록입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

top: number

반환할 최대 작업 항목 수 또는 커밋 ID가 지정되지 않은 경우 고려할 커밋 수입니다.

반환

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

지정된 두 빌드 간에 리포지토리에 대한 변경 내용을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

fromBuildId: number

첫 번째 빌드의 ID입니다.

toBuildId: number

마지막 빌드의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

minMetricsTime: Date

메트릭을 계산할 날짜입니다.

반환

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

정의에 대한 속성을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

filter: string[]

쉼표로 구분된 속성 목록입니다. 지정된 경우 이러한 특정 속성으로 필터링합니다.

반환

Promise<any>

getDefinitionResources(string, number)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

반환

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

정의의 모든 수정 버전을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

반환

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

프로젝트 ID 또는 프로젝트 이름

name: string

지정한 경우 이름이 이 패턴과 일치하는 정의를 필터링합니다.

repositoryId: string

리포지토리 ID입니다. 지정된 경우 이 리포지토리를 사용하는 정의로 필터링합니다.

repositoryType: string

지정된 경우 이 형식의 리포지토리가 있는 정의로 필터링합니다.

queryOrder: DefinitionQueryOrder

정의를 반환해야 하는 순서를 나타냅니다.

top: number

반환할 최대 정의 수입니다.

continuationToken: string

다음 정의 집합을 반환하는 데 사용할 수 있는 이 메서드에 대한 이전 호출에서 반환된 연속 토큰입니다.

minMetricsTime: Date

지정된 경우 메트릭을 포함해야 하는 날짜를 나타냅니다.

definitionIds: number[]

검색할 정의의 ID를 지정하는 쉼표로 구분된 목록입니다.

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

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

providerName: string

원본 공급자의 이름입니다.

serviceEndpointId: string

지정된 경우 쿼리할 서비스 엔드포인트의 ID입니다. 서비스 엔드포인트를 사용하지 않는 공급자(예: 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

프로젝트 ID 또는 프로젝트 이름

path: string

시작할 경로입니다.

queryOrder: FolderQueryOrder

폴더를 반환해야 하는 순서입니다.

반환

Promise<Folder[]>

getLatestBuild(string, string, string)

필요에 따라 특정 분기로 범위가 지정된 정의에 대한 최신 빌드를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

definition: string

선택적 선행 폴더 경로가 있는 정의 이름 또는 정의 ID

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

프로젝트 ID 또는 프로젝트 이름

providerName: string

원본 공급자의 이름입니다.

serviceEndpointId: string

지정된 경우 쿼리할 서비스 엔드포인트의 ID입니다. 서비스 엔드포인트를 사용하지 않는 공급자(예: 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

프로젝트 ID 또는 프로젝트 이름

metricAggregationType: string

사용할 집계 유형입니다(매시간, 매일).

minMetricsTime: Date

메트릭을 계산할 날짜입니다.

반환

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

providerName: string

원본 공급자의 이름입니다.

pullRequestId: string

끌어오기 요청의 공급업체별 ID입니다.

repositoryId: string

공급업체별 식별자 또는 끌어오기 요청을 포함하는 리포지토리의 이름입니다.

serviceEndpointId: string

지정된 경우 쿼리할 서비스 엔드포인트의 ID입니다. 서비스 엔드포인트를 사용하지 않는 공급자(예: 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)

임대 ID가 지정된 보존 임대의 세부 정보를 반환합니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

leaseId: number

반환

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

지정된 MinimalRetentionLeases와 일치하는 임대를 반환합니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

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

프로젝트 ID 또는 프로젝트 이름

userOwnerId: string

검색할 사용자 ID입니다.

definitionId: number

검색을 특정 파이프라인 정의로 제한하는 선택적 매개 변수입니다.

runId: number

검색을 단일 파이프라인 실행으로 제한하는 선택적 매개 변수입니다. definitionId가 필요합니다.

반환

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

특정 빌드에 적용되는 모든 보존 임대를 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

Promise<RetentionLease[]>

getRetentionSettings(string)

프로젝트의 보존 설정을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

반환

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

프로젝트 ID 또는 프로젝트 이름

definition: string

선택적 선행 폴더 경로가 있는 정의 이름 또는 정의 ID입니다.

branchName: string

이 분기에 대한 최신 빌드만 고려합니다. 지정하지 않으면 기본 분기 사용됩니다.

stageName: string

파이프라인 내에서 이 단계를 사용하여 상태 렌더링합니다.

jobName: string

파이프라인의 단계 내에서 이 작업을 사용하여 상태 렌더링합니다.

configuration: string

이 작업 구성을 사용하여 상태 렌더링

label: string

배지 왼쪽의 기본 텍스트를 바꿉니다.

반환

Promise<string>

getTags(string)

프로젝트의 모든 빌드 태그 목록을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<string[]>

getTemplate(string, string)

특정 빌드 정의 템플릿을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

templateId: string

요청된 템플릿의 ID입니다.

반환

Promise<BuildDefinitionTemplate>

getTemplates(string)

모든 정의 템플릿을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

두 빌드 간의 모든 작업 항목을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

fromBuildId: number

첫 번째 빌드의 ID입니다.

toBuildId: number

마지막 빌드의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

providerName: string

원본 공급자의 이름입니다.

serviceEndpointId: string

지정된 경우 쿼리할 서비스 엔드포인트의 ID입니다. 서비스 엔드포인트를 사용하지 않는 공급자(예: 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

프로젝트 ID 또는 프로젝트 이름

providerName: string

원본 공급자의 이름입니다.

serviceEndpointId: string

지정된 경우 쿼리할 서비스 엔드포인트의 ID입니다. 서비스 엔드포인트를 사용하지 않는 공급자(예: TFVC 또는 TFGit)에 대해서만 생략할 수 있습니다.

repository: string

지정된 경우 공급업체별 식별자 또는 가져올 단일 리포지토리의 이름입니다.

resultSet: ResultSet

엔드포인트와 가장 관련성이 큰 리포지토리의 'top'입니다. 설정하지 않으면 모든 리포지토리가 반환됩니다. '리포지토리'가 설정된 경우 무시됩니다.

pageResults: boolean

true로 설정하면 결과 집합이 제한되고 연속 토큰을 반환하여 쿼리를 계속합니다.

continuationToken: string

결과를 페이징할 때 다음 리포지토리 집합을 반환하는 데 사용할 수 있는 이 메서드에 대한 이전 호출에서 반환된 연속 토큰입니다.

반환

Promise<SourceRepositories>

listSourceProviders(string)

원본 공급자 및 해당 기능 목록을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

지정된 소스 코드 리포지토리에 설치된 웹후크 목록을 가져옵니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

providerName: string

원본 공급자의 이름입니다.

serviceEndpointId: string

지정된 경우 쿼리할 서비스 엔드포인트의 ID입니다. 서비스 엔드포인트를 사용하지 않는 공급자(예: TFVC 또는 TFGit)에 대해서만 생략할 수 있습니다.

repository: string

지정된 경우 공급업체별 식별자 또는 웹후크를 가져올 리포지토리의 이름입니다. 여러 리포지토리를 지원하지 않는 공급자에 대해서만 생략할 수 있습니다.

반환

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

프로젝트 ID 또는 프로젝트 이름

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

본문 없이 빌드를 큐에 대기하는 선택적 정의 ID입니다. 유효한 본문이 있는 경우 무시됨

반환

Promise<Build>

restoreDefinition(string, number, boolean)

삭제된 정의를 복원합니다.

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

매개 변수

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

복원할 정의의 식별자입니다.

deleted: boolean

false이면 삭제된 정의를 복원합니다.

반환

Promise<BuildDefinition>

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

지정된 소스 코드 리포지토리에서 지정된 트리거에 대한 웹후크를 다시 만듭니다.

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

매개 변수

triggerTypes: DefinitionTriggerType[]

웹후크를 복원할 트리거 유형입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

providerName: string

원본 공급자의 이름입니다.

serviceEndpointId: string

지정된 경우 쿼리할 서비스 엔드포인트의 ID입니다. 서비스 엔드포인트를 사용하지 않는 공급자(예: TFVC 또는 TFGit)에 대해서만 생략할 수 있습니다.

repository: string

반환

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

기존 빌드 정의 템플릿을 업데이트.

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

매개 변수

template: BuildDefinitionTemplate

템플릿의 새 버전입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

templateId: string

템플릿의 ID입니다.

반환

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

빌드를 업데이트.

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

매개 변수

build: Build

빌드입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

retry: boolean

반환

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

파이프라인 일반 설정을 업데이트.

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

매개 변수

newSettings: PipelineGeneralSettings

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

빌드에 대한 속성을 업데이트.

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

매개 변수

document: JsonPatchDocument

업데이트할 속성을 설명하는 json 패치 문서입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

Promise<any>

updateBuilds(Build[], string)

여러 빌드를 업데이트.

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

매개 변수

builds: Build[]

업데이트할 빌드입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

빌드 설정을 업데이트.

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

매개 변수

settings: BuildSettings

새 설정입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

빌드에서 태그를 추가/제거합니다.

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

매개 변수

updateParameters: UpdateTagParameters

추가/제거할 태그입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

buildId: number

빌드의 ID입니다.

반환

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

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

반환

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

정의에서 태그를 추가/제거합니다.

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

매개 변수

updateParameters: UpdateTagParameters

추가/제거할 태그입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

definitionId: number

정의의 ID입니다.

반환

Promise<string[]>

updateFolder(Folder, string, string)

지정된 기존 경로에서 기존 폴더 업데이트

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

매개 변수

folder: Folder

폴더의 새 버전입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

path: string

폴더의 전체 경로입니다.

반환

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

보존 임대의 기간 또는 파이프라인 보호 상태 업데이트.

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

매개 변수

leaseUpdate: RetentionLeaseUpdate

보존 임대에 대한 새 데이터입니다.

project: string

프로젝트 ID 또는 프로젝트 이름

leaseId: number

업데이트할 임대의 ID입니다.

반환

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

프로젝트의 보존 설정을 업데이트.

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

매개 변수

updateModel: UpdateProjectRetentionSettingModel

project: string

프로젝트 ID 또는 프로젝트 이름

반환

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

프로젝트 ID 또는 프로젝트 이름

반환

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)

매개 변수