다음을 통해 공유


Runs - Run Pipeline

파이프라인을 실행합니다.

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1-preview.1
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1-preview.1

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
organization
path True

string

Azure DevOps 조직의 이름입니다.

pipelineId
path True

integer

int32

파이프라인 ID입니다.

project
path True

string

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

api-version
query True

string

사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '7.1-preview.1'로 설정해야 합니다.

pipelineVersion
query

integer

int32

파이프라인 버전입니다.

요청 본문

Name 형식 Description
previewRun

boolean

true이면 실제로 새 실행을 만들지 마세요. 대신 템플릿을 구문 분석한 후 최종 YAML 문서를 반환합니다.

resources

RunResourcesParameters

실행에 필요한 리소스입니다.

stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

미리 보기 실행 옵션을 사용하는 경우 필요에 따라 다른 YAML을 제공할 수 있습니다. 이렇게 하면 변경된 파일을 커밋하지 않고도 최종 YAML 문서를 미리 볼 수 있습니다.

응답

Name 형식 Description
200 OK

Run

성공한 작업

보안

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.build_execute 빌드 결과, 정의 및 요청을 포함하여 빌드 아티팩트 액세스 기능과 빌드를 큐에 대기하고 빌드 속성을 업데이트하며 서비스 후크를 통해 빌드 이벤트에 대한 알림을 받을 수 있는 기능을 부여합니다.

정의

Name Description
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference

파이프라인에 대한 참조입니다.

PipelineResource
PipelineResourceParameters
ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters

파이프라인 실행에 영향을 미치는 설정입니다.

RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Name 형식 Description
version

string

Container

Name 형식 Description
environment

object

image

string

mapDockerSocket

boolean

options

string

ports

string[]

volumes

string[]

ContainerResource

Name 형식 Description
container

Container

ContainerResourceParameters

Name 형식 Description
version

string

PackageResourceParameters

Name 형식 Description
version

string

PipelineReference

파이프라인에 대한 참조입니다.

Name 형식 Description
folder

string

파이프라인 폴더

id

integer

파이프라인 ID

name

string

파이프라인 이름

revision

integer

수정 번호

url

string

PipelineResource

Name 형식 Description
pipeline

PipelineReference

파이프라인에 대한 참조입니다.

version

string

PipelineResourceParameters

Name 형식 Description
version

string

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name 형식 Description
links

object

링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

Repository

Name 형식 Description
type

RepositoryType

RepositoryResource

Name 형식 Description
refName

string

repository

Repository

version

string

RepositoryResourceParameters

Name 형식 Description
refName

string

token

string

리포지토리에 연결할 때 사용할 보안 토큰입니다.

tokenType

string

선택 사항입니다. 지정된 토큰의 형식입니다. 제공되지 않으면 "전달자" 형식이 가정됩니다. 참고: PAT 토큰에 "기본"을 사용합니다.

version

string

RepositoryType

Name 형식 Description
azureReposGit

string

azureReposGitHyphenated

string

gitHub

string

gitHubEnterprise

string

unknown

string

Run

Name 형식 Description
_links

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

createdDate

string

finalYaml

string

finishedDate

string

id

integer

name

string

pipeline

PipelineReference

파이프라인에 대한 참조입니다.

resources

RunResources

result

RunResult

state

RunState

templateParameters

object

url

string

variables

<string,  Variable>

RunPipelineParameters

파이프라인 실행에 영향을 미치는 설정입니다.

Name 형식 Description
previewRun

boolean

true이면 실제로 새 실행을 만들지 마세요. 대신 템플릿을 구문 분석한 후 최종 YAML 문서를 반환합니다.

resources

RunResourcesParameters

실행에 필요한 리소스입니다.

stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

미리 보기 실행 옵션을 사용하는 경우 필요에 따라 다른 YAML을 제공할 수 있습니다. 이렇게 하면 변경된 파일을 커밋하지 않고도 최종 YAML 문서를 미리 볼 수 있습니다.

RunResources

Name 형식 Description
containers

<string,  ContainerResource>

pipelines

<string,  PipelineResource>

repositories

<string,  RepositoryResource>

RunResourcesParameters

Name 형식 Description
builds

<string,  BuildResourceParameters>

containers

<string,  ContainerResourceParameters>

packages

<string,  PackageResourceParameters>

pipelines

<string,  PipelineResourceParameters>

repositories

<string,  RepositoryResourceParameters>

RunResult

Name 형식 Description
canceled

string

failed

string

succeeded

string

unknown

string

RunState

Name 형식 Description
canceling

string

completed

string

inProgress

string

unknown

string

Variable

Name 형식 Description
isSecret

boolean

value

string