Runs - Run Pipeline

Service:

Pipelines

API Version:

6.1-preview.1

Menjalankan alur.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
pipelineId	path	True	integer int32	ID alur.
project	path	True	string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '6.1-preview.1' untuk menggunakan versi api ini.
pipelineVersion	query		integer int32	Versi alur.

Isi Permintaan

Nama	Jenis	Deskripsi
previewRun	boolean	Jika true, jangan benar-benar membuat eksekusi baru. Sebagai gantinya, kembalikan dokumen YAML akhir setelah mengurai templat.
resources	RunResourcesParameters	Sumber daya yang dibutuhkan eksekusi.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Jika Anda menggunakan opsi eksekusi pratinjau, Anda dapat secara opsional menyediakan YAML yang berbeda. Ini memungkinkan Anda untuk mempratinjau dokumen YAML akhir tanpa menerapkan file yang diubah.

Respons

Nama	Jenis	Deskripsi
200 OK	Run	operasi berhasil

Keamanan

accessToken

Token akses pribadi. Gunakan nilai apa pun untuk nama pengguna dan token sebagai kata sandi.

Type: basic

Definisi

Nama	Deskripsi
BuildResourceParameters
ContainerResourceParameters
PackageResourceParameters
PipelineReference	Referensi ke Alur.
PipelineResourceParameters
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters	Pengaturan yang memengaruhi eksekusi alur.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Nama	Jenis	Deskripsi
version	string

ContainerResourceParameters

Nama	Jenis	Deskripsi
version	string

PackageResourceParameters

Nama	Jenis	Deskripsi
version	string

PipelineReference

Referensi ke Alur.

Nama	Jenis	Deskripsi
folder	string	Folder alur
id	integer	ID Alur
name	string	Nama alur
revision	integer	Nomor revisi
url	string

PipelineResourceParameters

Nama	Jenis	Deskripsi
version	string

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca saja.

Repository

Nama	Jenis	Deskripsi
type	RepositoryType

RepositoryResource

Nama	Jenis	Deskripsi
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Nama	Jenis	Deskripsi
refName	string
token	string	Ini adalah token keamanan yang digunakan saat menyambungkan ke repositori.
tokenType	string	Pilihan. Ini adalah jenis token yang diberikan. Jika tidak disediakan, jenis "Pembawa" diasumsikan. Catatan: Gunakan "Dasar" untuk token PAT.
version	string

RepositoryType

Nama	Jenis	Deskripsi
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
createdDate	string
finalYaml	string
finishedDate	string
id	integer
name	string
pipeline	PipelineReference	Referensi ke Alur.
resources	RunResources
result	RunResult
state	RunState
url	string
variables	<string,  Variable>

RunPipelineParameters

Pengaturan yang memengaruhi eksekusi alur.

Nama	Jenis	Deskripsi
previewRun	boolean	Jika true, jangan benar-benar membuat eksekusi baru. Sebagai gantinya, kembalikan dokumen YAML akhir setelah mengurai templat.
resources	RunResourcesParameters	Sumber daya yang dibutuhkan eksekusi.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Jika Anda menggunakan opsi eksekusi pratinjau, Anda dapat secara opsional menyediakan YAML yang berbeda. Ini memungkinkan Anda untuk mempratinjau dokumen YAML akhir tanpa menerapkan file yang diubah.

RunResources

Nama	Jenis	Deskripsi
repositories	<string,  RepositoryResource>

RunResourcesParameters

Nama	Jenis	Deskripsi
builds	<string,  BuildResourceParameters>
containers	<string,  ContainerResourceParameters>
packages	<string,  PackageResourceParameters>
pipelines	<string,  PipelineResourceParameters>
repositories	<string,  RepositoryResourceParameters>

RunResult

Nama	Jenis	Deskripsi
canceled	string
failed	string
succeeded	string
unknown	string

RunState

Nama	Jenis	Deskripsi
canceling	string
completed	string
inProgress	string
unknown	string

Variable

Nama	Jenis	Deskripsi
isSecret	boolean
value	string