Runs - Run Pipeline

Service:

Pipelines

API Version:

6.1-preview.1

パイプラインを実行します。

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

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=6.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 を使用するには、これを '6.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	正常な操作

セキュリティ

accessToken

個人用アクセス トークン。 ユーザー名とトークンに任意の値をパスワードとして使用します。

Type: basic

定義

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

BuildResourceParameters

名前	型	説明
version	string

ContainerResourceParameters

名前	型	説明
version	string

PackageResourceParameters

名前	型	説明
version	string

PipelineReference

パイプラインへの参照。

名前	型	説明
folder	string	パイプライン フォルダー
id	integer	パイプライン ID
name	string	パイプライン名
revision	integer	リビジョン番号
url	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
url	string
variables	<string,  Variable>

RunPipelineParameters

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

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

RunResources

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