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 パラメーター

名前	/	必須	型	説明
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	パイプライン バージョンです。

要求本文

名前	型	説明
previewRun	boolean	true の場合は、実際には新しい実行を作成しないでください。 代わりに、テンプレートの解析後に最終的な YAML ドキュメントを返します。
resources	RunResourcesParameters	実行に必要なリソース。
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	プレビュー実行オプションを使用する場合は、必要に応じて異なる YAML を指定できます。 これにより、変更されたファイルをコミットすることなく、最終的な YAML ドキュメントをプレビューできます。

応答

名前	型	説明
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

名前	説明
vso.build_execute	ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能、ビルドのキューに登録する機能、ビルド プロパティを更新する機能、およびサービス フックを介してビルド イベントに関する通知を受け取る機能を付与します。

定義

名前	説明
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference	パイプラインへの参照。
PipelineResource
PipelineResourceParameters
ReferenceLinks	REST 参照リンクのコレクションを表す クラス。
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters	パイプラインの実行に影響を与える設定。
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

名前	型	説明
version	string

Container

名前	型	説明
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

名前	型	説明
container	Container

ContainerResourceParameters

名前	型	説明
version	string

PackageResourceParameters

名前	型	説明
version	string

PipelineReference

パイプラインへの参照。

名前	型	説明
folder	string	パイプライン フォルダー
id	integer	パイプライン ID
name	string	パイプライン名
revision	integer	リビジョン番号
url	string

PipelineResource

名前	型	説明
pipeline	PipelineReference	パイプラインへの参照。
version	string

PipelineResourceParameters

名前	型	説明
version	string

ReferenceLinks

REST 参照リンクのコレクションを表す クラス。

名前	型	説明
links	object	リンクの読み取り専用ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

Repository

名前	型	説明
type	RepositoryType

RepositoryResource

名前	型	説明
refName	string
repository	Repository
version	string

RepositoryResourceParameters

名前	型	説明
refName	string
token	string	これは、リポジトリに接続するときに使用するセキュリティ トークンです。
tokenType	string	省略可能。 これは、指定されたトークンの型です。 指定しない場合は、"Bearer" の型が想定されます。 注: PAT トークンには "Basic" を使用します。
version	string

RepositoryType

名前	型	説明
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

名前	型	説明
_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

パイプラインの実行に影響を与える設定。

名前	型	説明
previewRun	boolean	true の場合は、実際には新しい実行を作成しないでください。 代わりに、テンプレートの解析後に最終的な YAML ドキュメントを返します。
resources	RunResourcesParameters	実行に必要なリソース。
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	プレビュー実行オプションを使用する場合は、必要に応じて異なる YAML を指定できます。 これにより、変更されたファイルをコミットすることなく、最終的な YAML ドキュメントをプレビューできます。

RunResources

名前	型	説明
containers	<string,  ContainerResource>
pipelines	<string,  PipelineResource>
repositories	<string,  RepositoryResource>

RunResourcesParameters

名前	型	説明
builds	<string,  BuildResourceParameters>
containers	<string,  ContainerResourceParameters>
packages	<string,  PackageResourceParameters>
pipelines	<string,  PipelineResourceParameters>
repositories	<string,  RepositoryResourceParameters>

RunResult

名前	型	説明
canceled	string
failed	string
succeeded	string
unknown	string

RunState

名前	型	説明
canceling	string
completed	string
inProgress	string
unknown	string

Variable

名前	型	説明
isSecret	boolean
value	string