Aracılığıyla paylaş

Runs - Run Pipeline

  • Başvuru
Hizmet:
Pipelines
API Sürümü:
7.1

bir işlem hattı çalıştırır.

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1
İsteğe bağlı parametrelerle: 
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1

URI Parametreleri

Name İçinde Gerekli Tür Description
organization
 path True

string

Azure DevOps kuruluşunun adı.
pipelineId
 path True

integer (int32)

İşlem hattı kimliği.
project
 path True

string

Proje kimliği veya proje adı
api-version
 query True

string

Kullanılacak API'nin sürümü. Bu, API'nin bu sürümünü kullanmak için '7.1' olarak ayarlanmalıdır.
pipelineVersion
 query

integer (int32)

İşlem hattı sürümü.

İstek Gövdesi

Name Tür Description
previewRun

boolean

True ise, yeni bir çalıştırma oluşturmayın. Bunun yerine, şablonları ayrıştırdıktan sonra son YAML belgesini döndürebilirsiniz.
resources

RunResourcesParameters

Çalıştırmanın gerektirdiği kaynaklar.
stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

Önizleme çalıştırması seçeneğini kullanırsanız, isteğe bağlı olarak farklı YAML sağlayabilirsiniz. Bu, değiştirilmiş bir dosya işlemeden son YAML belgesini önizlemenize olanak tanır.

Yanıtlar

Name Tür Description
200 OK

Run

başarılı işlem

Güvenlik

oauth2

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Belirteç URL'si: 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

Kapsamlar

Name Description
vso.build_execute Derleme sonuçları, tanımlar ve istekler dahil olmak üzere derleme yapıtlarına erişme ve derlemeyi kuyruğa alma, derleme özelliklerini güncelleştirme ve hizmet kancaları aracılığıyla derleme olayları hakkında bildirim alma olanağı verir.

Tanımlar

Name Description
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference

İşlem Hattı başvurusu.
PipelineResource
PipelineResourceParameters
ReferenceLinks

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters

İşlem hattı çalıştırmalarını etkileyen ayarlar.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Object
Name Tür Description
version

string

Container

Object
Name Tür Description
environment

object

image

string

mapDockerSocket

boolean

options

string

ports

string[]

volumes

string[]

ContainerResource

Object
Name Tür Description
container

Container

ContainerResourceParameters

Object
Name Tür Description
version

string

PackageResourceParameters

Object
Name Tür Description
version

string

PipelineReference

Object

İşlem Hattı başvurusu.

Name Tür Description
folder

string

İşlem hattı klasörü
id

integer (int32)

İşlem Hattı Kimliği
name

string

İşlem hattı adı
revision

integer (int32)

Düzeltme numarası
url

string

PipelineResource

Object
Name Tür Description
pipeline

PipelineReference

İşlem Hattı başvurusu.
version

string

PipelineResourceParameters

Object
Name Tür Description
version

string

Object

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

Name Tür Description
links

object

Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak kullanıma açmak istiyoruz.

Repository

Object
Name Tür Description
type

RepositoryType

RepositoryResource

Object
Name Tür Description
refName

string

repository

Repository

version

string

RepositoryResourceParameters

Object
Name Tür Description
refName

string

token

string

Bu, depoya bağlanırken kullanılacak güvenlik belirtecidir.
tokenType

string

Opsiyonel. Bu, verilen belirtecin türüdür. Sağlanmazsa, bir tür "Taşıyıcı" varsayılır. Not: PAT belirteci için "Temel" kullanın.
version

string

RepositoryType

Listeleme
Değer Description
azureReposGit
azureReposGitHyphenated
gitHub
gitHubEnterprise
unknown

Run

Object
Name Tür Description
_links

ReferenceLinks

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
createdDate

string (date-time)

finalYaml

string

finishedDate

string (date-time)

id

integer (int32)

name

string

pipeline

PipelineReference

İşlem Hattı başvurusu.
resources

RunResources

result

RunResult

state

RunState

templateParameters

object

url

string

variables

<string,  Variable>

RunPipelineParameters

Object

İşlem hattı çalıştırmalarını etkileyen ayarlar.

Name Tür Description
previewRun

boolean

True ise, yeni bir çalıştırma oluşturmayın. Bunun yerine, şablonları ayrıştırdıktan sonra son YAML belgesini döndürebilirsiniz.
resources

RunResourcesParameters

Çalıştırmanın gerektirdiği kaynaklar.
stagesToSkip

string[]

templateParameters

object

variables

<string,  Variable>

yamlOverride

string

Önizleme çalıştırması seçeneğini kullanırsanız, isteğe bağlı olarak farklı YAML sağlayabilirsiniz. Bu, değiştirilmiş bir dosya işlemeden son YAML belgesini önizlemenize olanak tanır.

RunResources

Object
Name Tür Description
containers

<string,  ContainerResource>

pipelines

<string,  PipelineResource>

repositories

<string,  RepositoryResource>

RunResourcesParameters

Object
Name Tür Description
builds

<string,  BuildResourceParameters>

containers

<string,  ContainerResourceParameters>

packages

<string,  PackageResourceParameters>

pipelines

<string,  PipelineResourceParameters>

repositories

<string,  RepositoryResourceParameters>

RunResult

Listeleme
Değer Description
canceled
failed
succeeded
unknown

RunState

Listeleme
Değer Description
canceling
completed
inProgress
unknown

Variable

Object
Name Tür Description
isSecret

boolean

value

string