Runs - Run Pipeline

服務:

Pipelines

API 版本:

7.1

執行管線。

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

含選擇性參數:

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

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
pipelineId	path	True	integer (int32)	管線標識碼。
project	path	True	string	項目識別碼或項目名稱
api-version	query	True	string	要使用的 API 版本。 這應該設定為 『7.1』 以使用此版本的 API。
pipelineVersion	query		integer (int32)	管線版本。

要求本文

名稱	類型	Description
previewRun	boolean	如果為 true，請勿實際建立新的執行。 相反地，在剖析範本之後傳回最終的 YAML 檔。
resources	RunResourcesParameters	執行所需的資源。
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	如果您使用預覽執行選項，您可以選擇性地提供不同的 YAML。 這可讓您預覽最終的 YAML 檔，而不需要認可變更的檔案。

回應

名稱	類型	Description
200 OK	Run	成功作業

安全性

oauth2

類型: oauth2
Flow: accessCode
授權 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
權杖 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

範圍

名稱	Description
vso.build_execute	授與存取組建成品的能力，包括建置結果、定義和要求，以及能夠將組建排入佇列、更新組建屬性，以及透過服務攔截接收建置事件的相關通知的能力。

定義

名稱	Description
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference	管線的參考。
PipelineResource
PipelineResourceParameters
ReferenceLinks	表示 REST 參考連結集合的類別。
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters	影響管線執行的設定。
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Object

名稱	類型	Description
version	string

Container

Object

名稱	類型	Description
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

Object

名稱	類型	Description
container	Container

ContainerResourceParameters

Object

名稱	類型	Description
version	string

PackageResourceParameters

Object

名稱	類型	Description
version	string

PipelineReference

Object

管線的參考。

名稱	類型	Description
folder	string	管線資料夾
id	integer (int32)	管線標識碼
name	string	管線名稱
revision	integer (int32)	修訂編號
url	string

PipelineResource

Object

名稱	類型	Description
pipeline	PipelineReference	管線的參考。
version	string

PipelineResourceParameters

Object

名稱	類型	Description
version	string

ReferenceLinks

Object

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的只讀檢視。 因為參考連結是只讀的，所以我們只想要將其公開為只讀。

Repository

Object

名稱	類型	Description
type	RepositoryType

RepositoryResource

Object

名稱	類型	Description
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Object

名稱	類型	Description
refName	string
token	string	這是連線到存放庫時要使用的安全性令牌。
tokenType	string	自選。 這是指定的令牌類型。 如果未提供，則會假設類型為 “Bearer”。 注意：針對 PAT 令牌使用「基本」。
version	string

RepositoryType

列舉型別

值	Description
azureReposGit
azureReposGitHyphenated
gitHub
gitHubEnterprise
unknown

Run

Object

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
createdDate	string (date-time)
finalYaml	string
finishedDate	string (date-time)
id	integer (int32)
name	string
pipeline	PipelineReference	管線的參考。
resources	RunResources
result	RunResult
state	RunState
templateParameters	object
url	string
variables	<string,  Variable>

RunPipelineParameters

Object

影響管線執行的設定。

名稱	類型	Description
previewRun	boolean	如果為 true，請勿實際建立新的執行。 相反地，在剖析範本之後傳回最終的 YAML 檔。
resources	RunResourcesParameters	執行所需的資源。
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	如果您使用預覽執行選項，您可以選擇性地提供不同的 YAML。 這可讓您預覽最終的 YAML 檔，而不需要認可變更的檔案。

RunResources

Object

名稱	類型	Description
containers	<string,  ContainerResource>
pipelines	<string,  PipelineResource>
repositories	<string,  RepositoryResource>

RunResourcesParameters

Object

名稱	類型	Description
builds	<string,  BuildResourceParameters>
containers	<string,  ContainerResourceParameters>
packages	<string,  PackageResourceParameters>
pipelines	<string,  PipelineResourceParameters>
repositories	<string,  RepositoryResourceParameters>

RunResult

列舉型別

值	Description
canceled
failed
succeeded
unknown

RunState

列舉型別

值	Description
canceling
completed
inProgress
unknown

Variable

Object

名稱	類型	Description
isSecret	boolean
value	string