Runs - Run Pipeline

Service:

Pipelines

API Version:

7.1-preview.1

執行管線。

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

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1-preview.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-preview.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

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

名稱	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

名稱	類型	Description
version	string

Container

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

ContainerResource

名稱	類型	Description
container	Container

ContainerResourceParameters

名稱	類型	Description
version	string

PackageResourceParameters

名稱	類型	Description
version	string

PipelineReference

管線的參考。

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

PipelineResource

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

PipelineResourceParameters

名稱	類型	Description
version	string

ReferenceLinks

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

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

Repository

名稱	類型	Description
type	RepositoryType

RepositoryResource

名稱	類型	Description
refName	string
repository	Repository
version	string

RepositoryResourceParameters

名稱	類型	Description
refName	string
token	string	這是連線至存放庫時要使用的安全性權杖。
tokenType	string	選擇性。 這是指定的權杖類型。 如果未提供，則會假設有類型為 「Bearer」。 注意：使用 「Basic」 作為 PAT 權杖。
version	string

RepositoryType

名稱	類型	Description
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

名稱	類型	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

會影響管線執行的設定。

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

RunResources

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

RunResourcesParameters

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

RunResult

名稱	類型	Description
canceled	string
failed	string
succeeded	string
unknown	string

RunState

名稱	類型	Description
canceling	string
completed	string
inProgress	string
unknown	string

Variable

名稱	類型	Description
isSecret	boolean
value	string