Runs - Run Pipeline

Service:

Pipelines

API Version:

7.1-preview.1

Spustí kanál.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
pipelineId	path	True	integer int32	ID kanálu.
project	path	True	string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.
pipelineVersion	query		integer int32	Verze kanálu.

Text požadavku

Name	Typ	Description
previewRun	boolean	Pokud ano, ve skutečnosti nové spuštění nevytvávejte. Místo toho po parsování šablon vraťte konečný dokument YAML.
resources	RunResourcesParameters	Prostředky, které spuštění vyžaduje.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Pokud použijete možnost spuštění ve verzi Preview, můžete volitelně zadat jiný YAML. To vám umožní zobrazit náhled konečného dokumentu YAML bez potvrzení změněný soubor.

Odpovědi

Name	Typ	Description
200 OK	Run	úspěšná operace

Zabezpečení

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

Name	Description
vso.build_execute	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost zařadit sestavení do fronty, aktualizovat vlastnosti sestavení a přijímat oznámení o událostech sestavení prostřednictvím připojení služeb.

Definice

Name	Description
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference	Odkaz na kanál.
PipelineResource
PipelineResourceParameters
ReferenceLinks	Třída představující kolekci odkazů REST.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters	Nastavení, která ovlivňují spuštění kanálu.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Name	Typ	Description
version	string

Container

Name	Typ	Description
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

Name	Typ	Description
container	Container

ContainerResourceParameters

Name	Typ	Description
version	string

PackageResourceParameters

Name	Typ	Description
version	string

PipelineReference

Odkaz na kanál.

Name	Typ	Description
folder	string	Složka kanálu
id	integer	ID kanálu
name	string	Název kanálu
revision	integer	Číslo revize
url	string

PipelineResource

Name	Typ	Description
pipeline	PipelineReference	Odkaz na kanál.
version	string

PipelineResourceParameters

Name	Typ	Description
version	string

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

Repository

Name	Typ	Description
type	RepositoryType

RepositoryResource

Name	Typ	Description
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Name	Typ	Description
refName	string
token	string	Toto je token zabezpečení, který se má použít při připojování k úložišti.
tokenType	string	Nepovinný parametr. Toto je typ daného tokenu. Pokud není zadán, předpokládá se typ "Nosný". Poznámka: Jako token PAT použijte "Basic".
version	string

RepositoryType

Name	Typ	Description
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
createdDate	string
finalYaml	string
finishedDate	string
id	integer
name	string
pipeline	PipelineReference	Odkaz na kanál.
resources	RunResources
result	RunResult
state	RunState
templateParameters	object
url	string
variables	<string,  Variable>

RunPipelineParameters

Nastavení, která ovlivňují spuštění kanálu.

Name	Typ	Description
previewRun	boolean	Pokud ano, ve skutečnosti nové spuštění nevytvávejte. Místo toho po parsování šablon vraťte konečný dokument YAML.
resources	RunResourcesParameters	Prostředky, které spuštění vyžaduje.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Pokud použijete možnost spuštění ve verzi Preview, můžete volitelně zadat jiný YAML. To vám umožní zobrazit náhled konečného dokumentu YAML bez potvrzení změněný soubor.

RunResources

Name	Typ	Description
containers	<string,  ContainerResource>
pipelines	<string,  PipelineResource>
repositories	<string,  RepositoryResource>

RunResourcesParameters

Name	Typ	Description
builds	<string,  BuildResourceParameters>
containers	<string,  ContainerResourceParameters>
packages	<string,  PackageResourceParameters>
pipelines	<string,  PipelineResourceParameters>
repositories	<string,  RepositoryResourceParameters>

RunResult

Name	Typ	Description
canceled	string
failed	string
succeeded	string
unknown	string

RunState

Name	Typ	Description
canceling	string
completed	string
inProgress	string
unknown	string

Variable

Name	Typ	Description
isSecret	boolean
value	string