ReleaseRestClient class

참조

패키지:: azure-devops-extension-api

VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

Extends: RestClientBase

생성자

ReleaseRestClient(IVssRestClientOptions)

속성

RESOURCE_AREA_ID

메서드

addDefinitionTag(string, number, string)	정의에 태그 추가
addDefinitionTags(string[], string, number)	정의에 여러 태그 추가
addReleaseTag(string, number, string)	releaseId에 태그 추가
addReleaseTags(string[], string, number)	릴리스에 태그 추가
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)	정의 환경 템플릿 만들기
createFavorites(FavoriteItem[], string, string, string)
createFolder(Folder, string, string)	새 폴더를 만듭니다.
createRelease(ReleaseStartMetadata, string)	릴리스를 만듭니다.
createReleaseDefinition(ReleaseDefinition, string)	릴리스 정의 만들기
deleteDefinitionEnvironmentTemplate(string, string)	정의 환경 템플릿 삭제
deleteDefinitionTag(string, number, string)	정의에서 태그를 삭제합니다.
deleteFavorites(string, string, string, string)
deleteFolder(string, string)	지정된 폴더 이름 및 경로 및 모든 기존 정의에 대한 정의 폴더를 삭제합니다.
deleteRelease(string, number, string)	릴리스 일시 삭제
deleteReleaseDefinition(string, number, string, boolean)	릴리스 정의를 삭제합니다.
deleteReleaseTag(string, number, string)	릴리스에서 태그를 삭제합니다.
getAgentArtifactDefinitions(string, number)	자동화 에이전트에 필요한 아티팩트 세부 정보를 반환합니다.
getApproval(string, number, boolean)	승인을 받습니다.
getApprovalHistory(string, number)	승인 기록을 가져옵니다.
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)	승인 목록 가져오기
getArtifactTypeDefinitions(string)
getArtifactVersions(string, number)
getArtifactVersionsForSources(Artifact[], string)
getAutoTriggerIssues(string, string, string, string)
getDefinitionEnvironments(string, string, string[])
getDefinitionEnvironmentTemplate(string, string)	정의 환경 템플릿을 가져옵니다.
getDefinitionRevision(string, number, number)	지정된 definitionId 및 수정 버전에 대한 릴리스 정의 가져오기
getDefinitionTags(string, number)	정의에 대한 태그를 가져옵니다.
getDeploymentBadge(string, number, number, string)	환경에 대한 최신 배포의 상태 나타내는 배지를 가져옵니다.
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)	배포 목록 가져오기
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
getFavorites(string, string, string)
getFlightAssignments(string)
getFolders(string, string, FolderPathQueryOrder)	폴더를 가져옵니다.
getGateLog(string, number, number, number, number)	게이트 로그를 가져옵니다.
getInputValues(InputValuesQuery, string)
getIssues(string, number, string)
getLog(string, number, number, number, number)	로그를 가져옵니다.
getLogs(string, number)	릴리스 ID에 대한 로그를 가져옵니다.
getManualIntervention(string, number, number)	지정된 릴리스 및 수동 개입 ID에 대한 수동 개입을 가져옵니다.
getManualInterventions(string, number)	지정된 릴리스에 대한 모든 수동 개입을 나열합니다.
getMetrics(string, Date)
getOrgPipelineReleaseSettings()	조직 파이프라인 릴리스 설정을 가져옵니다.
getPipelineReleaseSettings(string)	파이프라인 릴리스 설정을 가져옵니다.
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)	릴리스 가져오기
getReleaseChanges(string, number, number, number, string)
getReleaseDefinition(string, number, string[])	릴리스 정의를 가져옵니다.
getReleaseDefinitionHistory(string, number)	릴리스 정의에 대한 수정 기록 가져오기
getReleaseDefinitionRevision(string, number, number)	지정된 수정 버전의 릴리스 정의를 가져옵니다.
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)	릴리스 정의 목록을 가져옵니다.
getReleaseDefinitionSummary(string, number, number, boolean, number[])	지정된 정의 ID의 릴리스 요약을 가져옵니다.
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)	릴리스 환경을 가져옵니다.
getReleaseHistory(string, number)
getReleaseProjects(string, string)
getReleaseRevision(string, number, number)	지정된 수정 번호에 대한 릴리스를 가져옵니다.
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)	릴리스 목록 가져오기
getReleaseSettings(string)	릴리스 설정을 가져옵니다.
getReleaseTags(string, number)	릴리스의 태그를 가져옵니다.
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)	릴리스 작업 첨부 파일을 가져옵니다.
getReleaseTaskAttachments(string, number, number, number, string, string)	릴리스 작업 첨부 파일을 가져옵니다.
getReleaseWorkItemsRefs(string, number, number, number, string)
getSourceBranches(string, number)
getSummaryMailSections(string, number)
getTags(string)
getTaskAttachmentContent(string, number, number, number, string, string, string, string)	작업 첨부 파일을 가져옵니다.
getTaskAttachments(string, number, number, number, string, string)	작업 첨부 파일을 가져옵니다.
getTaskLog(string, number, number, number, number, number, number)	릴리스의 작업 로그를 일반 텍스트 파일로 가져옵니다.
getTaskLog2(string, number, number, number, string, number, number, number)	릴리스의 작업 로그를 일반 텍스트 파일로 가져옵니다.
getTasks(string, number, number, number)
getTasks2(string, number, number, number, string)
getTasksForTaskGroup(string, number, number, number)
listDefinitionEnvironmentTemplates(string, boolean)	정의 환경 템플릿 목록을 가져옵니다.
sendSummaryMail(MailMessage, string, number)
undeleteRelease(string, number, string)	일시 삭제된 릴리스 삭제 취소
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)	릴리스 정의를 삭제 취소합니다.
undeleteReleaseDefinitionEnvironmentTemplate(string, string)	릴리스 정의 환경 템플릿 삭제 취소
updateFolder(Folder, string, string)	지정된 기존 경로에서 기존 폴더를 업데이트.
updateGates(GateUpdateMetadata, string, number)	배포를 위한 게이트를 업데이트.
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)	수동 개입을 업데이트합니다.
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)	조직 파이프라인 릴리스 설정 업데이트
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)	파이프라인 릴리스 설정 업데이트
updateRelease(Release, string, number)	전체 릴리스 개체를 업데이트합니다.
updateReleaseApproval(ReleaseApproval, string, number)	승인 상태 업데이트
updateReleaseApprovals(ReleaseApproval[], string)
updateReleaseDefinition(ReleaseDefinition, string)	릴리스 정의를 업데이트합니다.
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)	릴리스 환경의 상태 업데이트
updateReleaseResource(ReleaseUpdateMetadata, string, number)	릴리스의 몇 가지 속성을 업데이트합니다.
updateReleaseSettings(ReleaseSettings, string)	릴리스 설정 업데이트

생성자 세부 정보

ReleaseRestClient(IVssRestClientOptions)

new ReleaseRestClient(options: IVssRestClientOptions)

매개 변수

options: IVssRestClientOptions

속성 세부 정보

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

속성 값

string

메서드 세부 정보

addDefinitionTag(string, number, string)

정의에 태그 추가

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

매개 변수

project: string

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

releaseDefinitionId: number

tag: string

반환

Promise<string[]>

addDefinitionTags(string[], string, number)

정의에 여러 태그 추가

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

매개 변수

tags: string[]

project: string

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

releaseDefinitionId: number

반환

Promise<string[]>

addReleaseTag(string, number, string)

releaseId에 태그 추가

function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>

매개 변수

project: string

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

releaseId: number

tag: string

반환

Promise<string[]>

addReleaseTags(string[], string, number)

릴리스에 태그 추가

function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>

매개 변수

tags: string[]

project: string

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

releaseId: number

반환

Promise<string[]>

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

정의 환경 템플릿 만들기

function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>

매개 변수

template: ReleaseDefinitionEnvironmentTemplate

만들 정의 환경 템플릿

project: string

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

반환

Promise<ReleaseDefinitionEnvironmentTemplate>

createFavorites(FavoriteItem[], string, string, string)

function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>

매개 변수

favoriteItems: FavoriteItem[]

project: string

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

scope: string

identityId: string

반환

Promise<FavoriteItem[]>

createFolder(Folder, string, string)

새 폴더를 만듭니다.

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

매개 변수

folder: Folder

폴더 아래에 번호가 매겨진 볼륨으로 표시됩니다.

project: string

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

path: string

폴더의 경로입니다.

반환

Promise<Folder>

createRelease(ReleaseStartMetadata, string)

릴리스를 만듭니다.

function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>

매개 변수

releaseStartMetadata: ReleaseStartMetadata

릴리스를 만드는 메타데이터입니다.

project: string

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

반환

Promise<Release>

createReleaseDefinition(ReleaseDefinition, string)

릴리스 정의 만들기

function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>

매개 변수

releaseDefinition: ReleaseDefinition

만들 릴리스 정의 개체입니다.

project: string

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

반환

Promise<ReleaseDefinition>

deleteDefinitionEnvironmentTemplate(string, string)

정의 환경 템플릿 삭제

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

매개 변수

project: string

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

templateId: string

정의 환경 템플릿의 ID

반환

Promise<void>

deleteDefinitionTag(string, number, string)

정의에서 태그를 삭제합니다.

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

매개 변수

project: string

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

releaseDefinitionId: number

tag: string

반환

Promise<string[]>

deleteFavorites(string, string, string, string)

function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>

매개 변수

project: string

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

scope: string

identityId: string

favoriteItemIds: string

반환

Promise<void>

deleteFolder(string, string)

지정된 폴더 이름 및 경로 및 모든 기존 정의에 대한 정의 폴더를 삭제합니다.

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

매개 변수

project: string

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

path: string

삭제할 폴더의 경로입니다.

반환

Promise<void>

deleteRelease(string, number, string)

릴리스 일시 삭제

function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

comment: string

릴리스 삭제에 대한 주석입니다.

반환

Promise<void>

deleteReleaseDefinition(string, number, string, boolean)

릴리스 정의를 삭제합니다.

function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>

매개 변수

project: string

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

definitionId: number

릴리스 정의의 ID입니다.

comment: string

릴리스 정의를 삭제하기 위한 주석입니다.

forceDelete: boolean

진행 중인 릴리스 배포를 자동으로 취소하고 릴리스 정의 삭제를 진행하려면 'true'입니다. 기본값은 'false'입니다.

반환

Promise<void>

deleteReleaseTag(string, number, string)

릴리스에서 태그를 삭제합니다.

function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>

매개 변수

project: string

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

releaseId: number

tag: string

반환

Promise<string[]>

getAgentArtifactDefinitions(string, number)

자동화 에이전트에 필요한 아티팩트 세부 정보를 반환합니다.

function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>

매개 변수

project: string

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

releaseId: number

반환

Promise<AgentArtifactDefinition[]>

getApproval(string, number, boolean)

승인을 받습니다.

function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>

매개 변수

project: string

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

approvalId: number

승인의 ID입니다.

includeHistory: boolean

승인 기록을 포함하려면 'true'입니다. 기본값은 'false'입니다.

반환

Promise<ReleaseApproval>

getApprovalHistory(string, number)

승인 기록을 가져옵니다.

function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>

매개 변수

project: string

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

approvalStepId: number

승인의 ID입니다.

반환

Promise<ReleaseApproval>

getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)

승인 목록 가져오기

function getApprovals(project: string, assignedToFilter?: string, statusFilter?: ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<PagedList<ReleaseApproval>>

매개 변수

project: string

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

assignedToFilter: string

이 사용자에게 할당된 승인입니다.

statusFilter: ApprovalStatus

이 상태 승인합니다. 기본값은 '보류 중'입니다.

releaseIdsFilter: number[]

필터에 언급된 릴리스 ID에 대한 승인입니다. 여러 릴리스를 ''(예: releaseIdsFilter=1,2,3,4)로 구분하여 언급할 수 있습니다.

typeFilter: ApprovalType

이 형식의 승인입니다.

top: number

가져올 승인 수입니다. 기본값은 50입니다.

continuationToken: number

제공된 연속 토큰 이후의 승인을 가져옵니다.

queryOrder: ReleaseQueryOrder

생성된 승인의 정의된 순서로 결과를 가져옵니다. 기본값은 '내림차순'입니다.

includeMyGroupApprovals: boolean

내 그룹 승인을 포함하려면 'true'입니다. 기본값은 'false'입니다.

반환

Promise<PagedList<ReleaseApproval>>

getArtifactTypeDefinitions(string)

function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>

매개 변수

project: string

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

반환

Promise<ArtifactTypeDefinition[]>

getArtifactVersions(string, number)

function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>

매개 변수

project: string

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

releaseDefinitionId: number

반환

Promise<ArtifactVersionQueryResult>

getArtifactVersionsForSources(Artifact[], string)

function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>

매개 변수

artifacts: Artifact[]

project: string

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

반환

Promise<ArtifactVersionQueryResult>

getAutoTriggerIssues(string, string, string, string)

function getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<AutoTriggerIssue[]>

매개 변수

artifactType: string

sourceId: string

artifactVersionId: string

project: string

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

반환

Promise<AutoTriggerIssue[]>

getDefinitionEnvironments(string, string, string[])

function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>

매개 변수

project: string

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

taskGroupId: string

propertyFilters: string[]

반환

Promise<DefinitionEnvironmentReference[]>

getDefinitionEnvironmentTemplate(string, string)

정의 환경 템플릿을 가져옵니다.

function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>

매개 변수

project: string

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

templateId: string

정의 환경 템플릿의 ID

반환

Promise<ReleaseDefinitionEnvironmentTemplate>

getDefinitionRevision(string, number, number)

지정된 definitionId 및 수정 버전에 대한 릴리스 정의 가져오기

function getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>

매개 변수

project: string

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

definitionId: number

정의의 ID입니다.

revision: number

수정 버전의 ID입니다.

반환

Promise<string>

getDefinitionTags(string, number)

정의에 대한 태그를 가져옵니다.

function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>

매개 변수

project: string

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

releaseDefinitionId: number

반환

Promise<string[]>

getDeploymentBadge(string, number, number, string)

환경에 대한 최신 배포의 상태 나타내는 배지를 가져옵니다.

function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>

매개 변수

projectId: string

프로젝트의 ID입니다.

releaseDefinitionId: number

릴리스 정의의 ID입니다.

environmentId: number

환경의 ID입니다.

branchName: string

분기의 이름입니다.

반환

Promise<string>

getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)

배포 목록 가져오기

function getDeployments(project: string, definitionId?: number, definitionEnvironmentId?: number, createdBy?: string, minModifiedTime?: Date, maxModifiedTime?: Date, deploymentStatus?: DeploymentStatus, operationStatus?: DeploymentOperationStatus, latestAttemptsOnly?: boolean, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, createdFor?: string, minStartedTime?: Date, maxStartedTime?: Date, sourceBranch?: string): Promise<PagedList<Deployment>>

매개 변수

project: string

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

definitionId: number

지정된 정의 ID에 대한 배포를 나열합니다.

definitionEnvironmentId: number

지정된 정의 환경 ID에 대한 배포를 나열합니다.

createdBy: string

지정된 ID로 배포가 만들어지는 배포를 나열합니다.

minModifiedTime: Date

LastModified time >= minModifiedTime을 사용하여 배포를 나열합니다.

maxModifiedTime: Date

LastModified time <= maxModifiedTime을 사용하여 배포를 나열합니다.

deploymentStatus: DeploymentStatus

지정된 배포 상태 사용하여 배포를 나열합니다. 기본값은 'All'입니다.

operationStatus: DeploymentOperationStatus

지정된 작업 상태 사용하여 배포를 나열합니다. 기본값은 'All'입니다.

latestAttemptsOnly: boolean

최신 시도만 있는 배포를 포함하려면 'true'입니다. 기본값은 'false'입니다.

queryOrder: ReleaseQueryOrder

지정된 쿼리 순서로 배포를 나열합니다. 기본값은 '내림차순'입니다.

top: number

지정된 위쪽의 배포를 나열합니다. 기본 상단은 '50'이고 최대 위쪽은 '100'입니다.

continuationToken: number

배포 ID >= continuationToken을 사용하여 배포를 나열합니다.

createdFor: string

지정된 ID로 배포가 요청되는 배포를 나열합니다.

minStartedTime: Date

StartedOn 시간 >= minStartedTime을 사용하여 배포를 나열합니다.

maxStartedTime: Date

StartedOn 시간 <= maxStartedTime을 사용하여 배포를 나열합니다.

sourceBranch: string

지정된 분기 이름에서 배포된 배포를 나열합니다.

반환

Promise<PagedList<Deployment>>

getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)

function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>

매개 변수

queryParameters: DeploymentQueryParameters

project: string

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

반환

Promise<Deployment[]>

getFavorites(string, string, string)

function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>

매개 변수

project: string

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

scope: string

identityId: string

반환

Promise<FavoriteItem[]>

getFlightAssignments(string)

function getFlightAssignments(flightName?: string): Promise<string[]>

매개 변수

flightName: string

반환

Promise<string[]>

getFolders(string, string, FolderPathQueryOrder)

폴더를 가져옵니다.

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

매개 변수

project: string

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

path: string

폴더의 경로입니다.

queryOrder: FolderPathQueryOrder

정의된 순서로 결과를 가져옵니다. 기본값은 'None'입니다.

반환

Promise<Folder[]>

getGateLog(string, number, number, number, number)

게이트 로그를 가져옵니다.

function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

gateId: number

게이트의 ID입니다.

taskId: number

로그의 ReleaseTask ID입니다.

반환

Promise<string>

getInputValues(InputValuesQuery, string)

function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>

매개 변수

query: InputValuesQuery

project: string

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

반환

Promise<InputValuesQuery>

getIssues(string, number, string)

function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>

매개 변수

project: string

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

buildId: number

sourceId: string

반환

Promise<AutoTriggerIssue[]>

getLog(string, number, number, number, number)

로그를 가져옵니다.

function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

taskId: number

로그의 ReleaseTask ID입니다.

attemptId: number

시도의 ID입니다.

반환

Promise<string>

getLogs(string, number)

릴리스 ID에 대한 로그를 가져옵니다.

function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

반환

Promise<ArrayBuffer>

getManualIntervention(string, number, number)

지정된 릴리스 및 수동 개입 ID에 대한 수동 개입을 가져옵니다.

function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

manualInterventionId: number

수동 개입의 ID입니다.

반환

Promise<ManualIntervention>

getManualInterventions(string, number)

지정된 릴리스에 대한 모든 수동 개입을 나열합니다.

function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

반환

Promise<ManualIntervention[]>

getMetrics(string, Date)

function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>

매개 변수

project: string

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

minMetricsTime: Date

반환

Promise<Metric[]>

getOrgPipelineReleaseSettings()

조직 파이프라인 릴리스 설정을 가져옵니다.

function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>

반환

Promise<OrgPipelineReleaseSettings>

getPipelineReleaseSettings(string)

파이프라인 릴리스 설정을 가져옵니다.

function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>

매개 변수

project: string

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

반환

Promise<ProjectPipelineReleaseSettings>

getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)

릴리스 가져오기

function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number): Promise<Release>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

approvalFilters: ApprovalFilters

자동화 또는 수동 여부에 따라 선택적으로 승인 단계를 가져올 수 있는 필터입니다. 또한 사전 및 사후 승인 스냅샷을 가져와야 하는지 여부도 결정합니다. 기본적으로 All을 가정합니다.

propertyFilters: string[]

검색할 확장 속성의 쉼표로 구분된 목록입니다. 설정된 경우 반환된 Release에는 지정된 속성 ID(있는 경우)에 대한 값이 포함됩니다. 설정하지 않으면 속성이 포함되지 않습니다.

expand: SingleReleaseExpands

릴리스에서 확장해야 하는 속성입니다.

topGateRecords: number

가져올 릴리스 게이트 레코드의 수입니다. 기본값은 5입니다.

반환

Promise<Release>

getReleaseChanges(string, number, number, number, string)

function getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<Change[]>

매개 변수

project: string

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

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

반환

Promise<Change[]>

getReleaseDefinition(string, number, string[])

릴리스 정의를 가져옵니다.

function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): Promise<ReleaseDefinition>

매개 변수

project: string

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

definitionId: number

릴리스 정의의 ID입니다.

propertyFilters: string[]

검색할 확장 속성의 쉼표로 구분된 목록입니다. 설정된 경우 반환된 릴리스 정의에는 지정된 속성 ID(있는 경우)에 대한 값이 포함됩니다. 설정하지 않으면 속성이 포함되지 않습니다.

반환

Promise<ReleaseDefinition>

getReleaseDefinitionHistory(string, number)

릴리스 정의에 대한 수정 기록 가져오기

function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>

매개 변수

project: string

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

definitionId: number

정의의 ID입니다.

반환

Promise<ReleaseDefinitionRevision[]>

getReleaseDefinitionRevision(string, number, number)

지정된 수정 버전의 릴리스 정의를 가져옵니다.

function getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>

매개 변수

project: string

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

definitionId: number

릴리스 정의의 ID입니다.

revision: number

릴리스 정의의 수정 번호입니다.

반환

Promise<string>

getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)

릴리스 정의 목록을 가져옵니다.

function getReleaseDefinitions(project: string, searchText?: string, expand?: ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean, searchTextContainsFolderName?: boolean): Promise<PagedList<ReleaseDefinition>>

매개 변수

project: string

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

searchText: string

searchText를 포함하는 이름의 릴리스 정의를 가져옵니다.

expand: ReleaseDefinitionExpands

릴리스 정의 목록에서 확장해야 하는 속성입니다.

artifactType: string

지정된 artifactType이 있는 릴리스 정의가 반환됩니다. 값은 Build, Jenkins, GitHub, Nuget, Team Build(외부), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild일 수 있습니다.

artifactSourceId: string

지정된 artifactSourceId가 있는 릴리스 정의가 반환됩니다. 예를 들어 빌드의 경우 {projectGuid}:{BuildDefinitionId}이고, Jenkins의 경우 {JenkinsConnectionId}:{JenkinsDefinitionId}이고, TfsOnPrem의 경우 {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}입니다. 타사 아티팩트(예: TeamCity, BitBucket)의 경우 에서 vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions내에서 'uniqueSourceIdentifier'를 참조할 수 있습니다.

top: number

가져올 릴리스 정의 수입니다.

continuationToken: string

제공된 연속 토큰 이후의 릴리스 정의를 가져옵니다.

queryOrder: ReleaseDefinitionQueryOrder

정의된 순서로 결과를 가져옵니다. 기본값은 'IdAscending'입니다.

path: string

지정된 경로 아래의 릴리스 정의를 가져옵니다.

isExactNameMatch: boolean

'true'는 searchText에 지정된 것과 정확히 일치하는 릴리스 정의를 가져옵니다. 기본값은 'false'입니다.

tagFilter: string[]

쉼표로 구분된 태그 목록입니다. 이러한 태그가 있는 릴리스 정의만 반환됩니다.

propertyFilters: string[]

검색할 확장 속성의 쉼표로 구분된 목록입니다. 설정된 경우 반환된 릴리스 정의에는 지정된 속성 ID에 대한 값이 포함됩니다(있는 경우). 설정하지 않으면 속성이 포함되지 않습니다. 속성이 설정되었는지 여부에 관계없이 결과에서 릴리스 정의를 필터링하지 않습니다.

definitionIdFilter: string[]

검색할 릴리스 정의의 쉼표로 구분된 목록입니다.

isDeleted: boolean

삭제된 릴리스 정의를 가져오는 'true'입니다. 기본값은 'false'입니다.

searchTextContainsFolderName: boolean

'true'을(를) 사용하여 searchText에 지정된 이름으로 폴더 아래에 릴리스 정의를 가져옵니다. 기본값은 'false'입니다.

반환

Promise<PagedList<ReleaseDefinition>>

getReleaseDefinitionSummary(string, number, number, boolean, number[])

지정된 정의 ID의 릴리스 요약을 가져옵니다.

function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>

매개 변수

project: string

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

definitionId: number

릴리스 요약을 가져올 정의의 ID입니다.

releaseCount: number

요약에 포함할 릴리스 수입니다.

includeArtifact: boolean

아티팩트 세부 정보를 포함합니다. 기본값은 'false'입니다.

definitionEnvironmentIdsFilter: number[]

반환

Promise<ReleaseDefinitionSummary>

getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)

릴리스 환경을 가져옵니다.

function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

expand: ReleaseEnvironmentExpands

환경에서 확장해야 하는 속성입니다.

반환

Promise<ReleaseEnvironment>

getReleaseHistory(string, number)

function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>

매개 변수

project: string

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

releaseId: number

반환

Promise<ReleaseRevision[]>

getReleaseProjects(string, string)

function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>

매개 변수

artifactType: string

artifactSourceId: string

반환

Promise<ProjectReference[]>

getReleaseRevision(string, number, number)

지정된 수정 번호에 대한 릴리스를 가져옵니다.

function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

definitionSnapshotRevision: number

정의 스냅샷 수정 번호입니다.

반환

Promise<string>

getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)

릴리스 목록 가져오기

function getReleases(project?: string, definitionId?: number, definitionEnvironmentId?: number, searchText?: string, createdBy?: string, statusFilter?: ReleaseStatus, environmentStatusFilter?: number, minCreatedTime?: Date, maxCreatedTime?: Date, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, expand?: ReleaseExpands, artifactTypeId?: string, sourceId?: string, artifactVersionId?: string, sourceBranchFilter?: string, isDeleted?: boolean, tagFilter?: string[], propertyFilters?: string[], releaseIdFilter?: number[], path?: string): Promise<PagedList<Release>>

매개 변수

project: string

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

definitionId: number

이 릴리스 정의 ID에서 릴리스됩니다.

definitionEnvironmentId: number

searchText: string

searchText를 포함하는 이름의 릴리스입니다.

createdBy: string

이 사용자가 만든 릴리스입니다.

statusFilter: ReleaseStatus

이 상태 있는 릴리스입니다.

environmentStatusFilter: number

minCreatedTime: Date

이 시간 이후에 만들어진 릴리스입니다.

maxCreatedTime: Date

이 시간 전에 만들어진 릴리스입니다.

queryOrder: ReleaseQueryOrder

릴리스에 대해 생성된 날짜의 정의된 순서로 결과를 가져옵니다. 기본값은 내림차순입니다.

top: number

가져올 릴리스 수입니다. 기본값은 50입니다.

continuationToken: number

제공된 연속 토큰 이후의 릴리스를 가져옵니다.

expand: ReleaseExpands

릴리스 목록에서 확장해야 하는 속성입니다.

artifactTypeId: string

지정된 artifactTypeId가 있는 릴리스가 반환됩니다. 값은 Build, Jenkins, GitHub, Nuget, Team Build(외부), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild일 수 있습니다.

sourceId: string

사용된 아티팩트 고유 식별자입니다. 예를 들어 빌드의 경우 {projectGuid}:{BuildDefinitionId}이고, Jenkins의 경우 {JenkinsConnectionId}:{JenkinsDefinitionId}이고, TfsOnPrem의 경우 {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}입니다. 타사 아티팩트(예: TeamCity, BitBucket)의 경우 vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions내에서 'uniqueSourceIdentifier'를 참조할 수 있습니다.

artifactVersionId: string

지정된 artifactVersionId가 있는 릴리스가 반환됩니다. 예를 들어 Build artifactType의 경우 buildId입니다.

sourceBranchFilter: string

지정된 sourceBranchFilter가 있는 릴리스가 반환됩니다.

isDeleted: boolean

true인 경우 일시 삭제된 릴리스를 가져옵니다.

tagFilter: string[]

쉼표로 구분된 태그 목록입니다. 이러한 태그가 있는 릴리스만 반환됩니다.

propertyFilters: string[]

검색할 확장 속성의 쉼표로 구분된 목록입니다. 설정된 경우 반환된 Releases에는 지정된 속성 ID에 대한 값이 포함됩니다(있는 경우). 설정하지 않으면 속성이 포함되지 않습니다. 속성 집합이 있는지 여부에 관계없이 결과에서 릴리스를 필터링하지 않습니다.

releaseIdFilter: number[]

쉼표로 구분된 릴리스 ID 목록입니다. 이러한 ID가 있는 릴리스만 반환됩니다.

path: string

이 폴더 경로 아래의 릴리스가 반환됩니다.

반환

Promise<PagedList<Release>>

getReleaseSettings(string)

릴리스 설정을 가져옵니다.

function getReleaseSettings(project: string): Promise<ReleaseSettings>

매개 변수

project: string

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

반환

Promise<ReleaseSettings>

getReleaseTags(string, number)

릴리스의 태그를 가져옵니다.

function getReleaseTags(project: string, releaseId: number): Promise<string[]>

매개 변수

project: string

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

releaseId: number

반환

Promise<string[]>

getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)

릴리스 작업 첨부 파일을 가져옵니다.

function getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

attemptId: number

배포 시도 횟수입니다.

planId: string

배포 단계의 계획 ID입니다.

timelineId: string

작업의 타임라인 ID입니다.

recordId: string

첨부 파일의 레코드 ID입니다.

type: string

첨부 파일의 형식입니다.

name: string

첨부 파일의 이름입니다.

반환

Promise<ArrayBuffer>

getReleaseTaskAttachments(string, number, number, number, string, string)

릴리스 작업 첨부 파일을 가져옵니다.

function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

attemptId: number

배포 시도 횟수입니다.

planId: string

배포 단계의 계획 ID입니다.

type: string

첨부 파일의 형식입니다.

반환

Promise<ReleaseTaskAttachment[]>

getReleaseWorkItemsRefs(string, number, number, number, string)

function getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseWorkItemRef[]>

매개 변수

project: string

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

releaseId: number

baseReleaseId: number

top: number

artifactAlias: string

반환

Promise<ReleaseWorkItemRef[]>

getSourceBranches(string, number)

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

매개 변수

project: string

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

definitionId: number

반환

Promise<string[]>

getSummaryMailSections(string, number)

function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>

매개 변수

project: string

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

releaseId: number

반환

Promise<SummaryMailSection[]>

getTags(string)

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

매개 변수

project: string

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

반환

Promise<string[]>

getTaskAttachmentContent(string, number, number, number, string, string, string, string)

작업 첨부 파일을 가져옵니다.

function getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

attemptId: number

배포 시도 횟수입니다.

timelineId: string

작업의 타임라인 ID입니다.

recordId: string

첨부 파일의 레코드 ID입니다.

type: string

첨부 파일의 형식입니다.

name: string

첨부 파일의 이름입니다.

반환

Promise<ArrayBuffer>

getTaskAttachments(string, number, number, number, string, string)

작업 첨부 파일을 가져옵니다.

function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

attemptId: number

배포 시도 횟수입니다.

timelineId: string

작업의 타임라인 ID입니다.

type: string

첨부 파일의 형식입니다.

반환

Promise<ReleaseTaskAttachment[]>

getTaskLog(string, number, number, number, number, number, number)

릴리스의 작업 로그를 일반 텍스트 파일로 가져옵니다.

function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

releaseDeployPhaseId: number

릴리스 배포 단계 ID입니다.

taskId: number

로그의 ReleaseTask ID입니다.

startLine: number

로그의 시작 줄 번호

endLine: number

로그의 끝 줄 번호

반환

Promise<string>

getTaskLog2(string, number, number, number, string, number, number, number)

릴리스의 작업 로그를 일반 텍스트 파일로 가져옵니다.

function getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<string>

매개 변수

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

attemptId: number

timelineId: string

taskId: number

로그의 ReleaseTask ID입니다.

startLine: number

로그의 시작 줄 번호

endLine: number

로그의 끝 줄 번호

반환

Promise<string>

getTasks(string, number, number, number)

function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>

매개 변수

project: string

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

releaseId: number

environmentId: number

attemptId: number

반환

Promise<ReleaseTask[]>

getTasks2(string, number, number, number, string)

function getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseTask[]>

매개 변수

project: string

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

releaseId: number

environmentId: number

attemptId: number

timelineId: string

반환

Promise<ReleaseTask[]>

getTasksForTaskGroup(string, number, number, number)

function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>

매개 변수

project: string

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

releaseId: number

environmentId: number

releaseDeployPhaseId: number

반환

Promise<ReleaseTask[]>

listDefinitionEnvironmentTemplates(string, boolean)

정의 환경 템플릿 목록을 가져옵니다.

function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>

매개 변수

project: string

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

isDeleted: boolean

삭제된 정의 환경 템플릿을 가져오는 'true'입니다. 기본값은 'false'입니다.

반환

Promise<ReleaseDefinitionEnvironmentTemplate[]>

sendSummaryMail(MailMessage, string, number)

function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>

매개 변수

mailMessage: MailMessage

project: string

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

releaseId: number

반환

Promise<void>

undeleteRelease(string, number, string)

일시 삭제된 릴리스 삭제 취소

function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>

매개 변수

project: string

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

releaseId: number

삭제할 릴리스의 ID입니다.

comment: string

삭제 취소에 대한 모든 주석입니다.

반환

Promise<void>

undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)

릴리스 정의를 삭제 취소합니다.

function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>

매개 변수

releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter

릴리스 정의를 삭제 취소하기 위한 개체입니다.

project: string

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

definitionId: number

삭제 취소할 릴리스 정의의 ID

반환

Promise<ReleaseDefinition>

undeleteReleaseDefinitionEnvironmentTemplate(string, string)

릴리스 정의 환경 템플릿 삭제 취소

function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>

매개 변수

project: string

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

templateId: string

삭제할 정의 환경 템플릿의 ID

반환

Promise<ReleaseDefinitionEnvironmentTemplate>

updateFolder(Folder, string, string)

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

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

매개 변수

folder: Folder

폴더 아래에 번호가 매겨진 볼륨으로 표시됩니다.

project: string

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

path: string

업데이트할 폴더의 경로입니다.

반환

Promise<Folder>

updateGates(GateUpdateMetadata, string, number)

배포를 위한 게이트를 업데이트.

function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>

매개 변수

gateUpdateMetadata: GateUpdateMetadata

릴리스 게이트를 패치하는 메타데이터입니다.

project: string

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

gateStepId: number

게이트 단계 ID입니다.

반환

Promise<ReleaseGates>

updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)

수동 개입을 업데이트합니다.

function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>

매개 변수

manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata

수동 개입을 업데이트하는 메타 데이터입니다.

project: string

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

releaseId: number

릴리스의 ID입니다.

manualInterventionId: number

수동 개입의 ID입니다.

반환

Promise<ManualIntervention>

updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)

조직 파이프라인 릴리스 설정 업데이트

function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>

매개 변수

newSettings: OrgPipelineReleaseSettingsUpdateParameters

반환

Promise<OrgPipelineReleaseSettings>

updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)

파이프라인 릴리스 설정 업데이트

function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>

매개 변수

newSettings: ProjectPipelineReleaseSettingsUpdateParameters

project: string

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

반환

Promise<ProjectPipelineReleaseSettings>

updateRelease(Release, string, number)

전체 릴리스 개체를 업데이트합니다.

function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>

매개 변수

release: Release

업데이트할 릴리스 개체입니다.

project: string

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

releaseId: number

업데이트할 릴리스의 ID입니다.

반환

Promise<Release>

updateReleaseApproval(ReleaseApproval, string, number)

승인 상태 업데이트

function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>

매개 변수

approval: ReleaseApproval

상태, 승인자 및 주석이 있는 ReleaseApproval 개체입니다.

project: string

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

approvalId: number

승인의 ID입니다.

반환

Promise<ReleaseApproval>

updateReleaseApprovals(ReleaseApproval[], string)

function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>

매개 변수

approvals: ReleaseApproval[]

project: string

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

반환

Promise<ReleaseApproval[]>

updateReleaseDefinition(ReleaseDefinition, string)

릴리스 정의를 업데이트합니다.

function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>

매개 변수

releaseDefinition: ReleaseDefinition

업데이트할 정의 개체를 해제합니다.

project: string

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

반환

Promise<ReleaseDefinition>

updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)

릴리스 환경의 상태 업데이트

function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>

매개 변수

environmentUpdateData: ReleaseEnvironmentUpdateMetadata

환경 업데이트 메타 데이터입니다.

project: string

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

releaseId: number

릴리스의 ID입니다.

environmentId: number

릴리스 환경의 ID입니다.

반환

Promise<ReleaseEnvironment>

updateReleaseResource(ReleaseUpdateMetadata, string, number)

릴리스의 몇 가지 속성을 업데이트합니다.

function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>

매개 변수

releaseUpdateMetadata: ReleaseUpdateMetadata

업데이트할 릴리스의 속성입니다.

project: string

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

releaseId: number

업데이트할 릴리스의 ID입니다.

반환

Promise<Release>

updateReleaseSettings(ReleaseSettings, string)

릴리스 설정 업데이트

function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>

매개 변수

releaseSettings: ReleaseSettings

project: string

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

반환

Promise<ReleaseSettings>

다음을 통해 공유

ReleaseRestClient class

생성자

속성

메서드

생성자 세부 정보

ReleaseRestClient(IVssRestClientOptions)

매개 변수

속성 세부 정보

RESOURCE_AREA_ID

속성 값

메서드 세부 정보

addDefinitionTag(string, number, string)

매개 변수

반환

addDefinitionTags(string[], string, number)

매개 변수

반환

addReleaseTag(string, number, string)

매개 변수

반환

addReleaseTags(string[], string, number)

매개 변수

반환

createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)

매개 변수

반환

createFavorites(FavoriteItem[], string, string, string)

매개 변수

반환

createFolder(Folder, string, string)

매개 변수

반환

createRelease(ReleaseStartMetadata, string)

매개 변수

반환

createReleaseDefinition(ReleaseDefinition, string)

매개 변수

반환

deleteDefinitionEnvironmentTemplate(string, string)

매개 변수

반환

deleteDefinitionTag(string, number, string)

매개 변수

반환

deleteFavorites(string, string, string, string)

매개 변수

반환

deleteFolder(string, string)

매개 변수

반환

deleteRelease(string, number, string)

매개 변수

반환

deleteReleaseDefinition(string, number, string, boolean)

매개 변수

반환

deleteReleaseTag(string, number, string)

매개 변수

반환

getAgentArtifactDefinitions(string, number)

매개 변수

반환

getApproval(string, number, boolean)

매개 변수

반환

getApprovalHistory(string, number)

매개 변수

반환

getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)

매개 변수

반환

getArtifactTypeDefinitions(string)

매개 변수

반환

getArtifactVersions(string, number)

매개 변수

반환

getArtifactVersionsForSources(Artifact[], string)

매개 변수