PipelinesRestClient class
VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
생성자
| Pipelines |
메서드
| create |
파이프라인을 만듭니다. |
| get |
파이프라인 실행에서 특정 아티팩트 가져오기 |
| get |
파이프라인 실행에서 특정 로그 가져오기 |
| get |
필요에 따라 지정된 버전에서 파이프라인을 가져옵니다. |
| get |
특정 파이프라인에 대한 실행을 가져옵니다. |
| list |
파이프라인 실행에서 로그 목록을 가져옵니다. |
| list |
파이프라인 목록을 가져옵니다. |
| list |
특정 파이프라인에 대한 상위 10000개 실행을 가져옵니다. |
| preview(Run |
파이프라인의 시험 실행을 큐에 대기하고 최종 yaml을 포함하는 개체를 반환합니다. |
| run |
파이프라인을 실행합니다. |
생성자 세부 정보
PipelinesRestClient(IVssRestClientOptions)
메서드 세부 정보
createPipeline(CreatePipelineParameters, string)
파이프라인을 만듭니다.
function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>매개 변수
- inputParameters
- CreatePipelineParameters
입력 매개 변수.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
반환
Promise<Pipeline>
getArtifact(string, number, number, string, GetArtifactExpandOptions)
파이프라인 실행에서 특정 아티팩트 가져오기
function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- pipelineId
-
number
파이프라인의 ID입니다.
- runId
-
number
해당 파이프라인의 실행 ID입니다.
- artifactName
-
string
아티팩트 이름입니다.
- expand
- GetArtifactExpandOptions
옵션을 확장합니다. 기본값은 None입니다.
반환
Promise<Artifact>
getLog(string, number, number, number, GetLogExpandOptions)
파이프라인 실행에서 특정 로그 가져오기
function getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: GetLogExpandOptions): Promise<Log>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- pipelineId
-
number
파이프라인의 ID입니다.
- runId
-
number
해당 파이프라인의 실행 ID입니다.
- logId
-
number
로그의 ID입니다.
- expand
- GetLogExpandOptions
옵션을 확장합니다. 기본값은 None입니다.
반환
Promise<Log>
getPipeline(string, number, number)
필요에 따라 지정된 버전에서 파이프라인을 가져옵니다.
function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- pipelineId
-
number
파이프라인 ID
- pipelineVersion
-
number
파이프라인 버전
반환
Promise<Pipeline>
getRun(string, number, number)
특정 파이프라인에 대한 실행을 가져옵니다.
function getRun(project: string, pipelineId: number, runId: number): Promise<Run>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- pipelineId
-
number
파이프라인 ID
- runId
-
number
실행 ID
반환
Promise<Run>
listLogs(string, number, number, GetLogExpandOptions)
파이프라인 실행에서 로그 목록을 가져옵니다.
function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- pipelineId
-
number
파이프라인의 ID입니다.
- runId
-
number
해당 파이프라인의 실행 ID입니다.
- expand
- GetLogExpandOptions
옵션을 확장합니다. 기본값은 None입니다.
반환
Promise<LogCollection>
listPipelines(string, string, number, string)
파이프라인 목록을 가져옵니다.
function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- orderBy
-
string
정렬 식입니다. 기본값은 "name asc"입니다.
- top
-
number
반환할 최대 파이프라인 수
- continuationToken
-
string
결과의 다음 페이지를 검색하기 위한 이전 요청의 연속 토큰
반환
Promise<Pipeline[]>
listRuns(string, number)
특정 파이프라인에 대한 상위 10000개 실행을 가져옵니다.
function listRuns(project: string, pipelineId: number): Promise<Run[]>매개 변수
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- pipelineId
-
number
파이프라인 ID
반환
Promise<Run[]>
preview(RunPipelineParameters, string, number, number)
파이프라인의 시험 실행을 큐에 대기하고 최종 yaml을 포함하는 개체를 반환합니다.
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>매개 변수
- runParameters
- RunPipelineParameters
이 실행에 대한 선택적 추가 매개 변수입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- pipelineId
-
number
파이프라인 ID입니다.
- pipelineVersion
-
number
파이프라인 버전입니다.
반환
Promise<PreviewRun>
runPipeline(RunPipelineParameters, string, number, number)
파이프라인을 실행합니다.
function runPipeline(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Run>매개 변수
- runParameters
- RunPipelineParameters
이 실행에 대한 선택적 추가 매개 변수입니다.
- project
-
string
프로젝트 ID 또는 프로젝트 이름
- pipelineId
-
number
파이프라인 ID입니다.
- pipelineVersion
-
number
파이프라인 버전입니다.
반환
Promise<Run>