Runs - Run Pipeline

Service:

Pipelines

API Version:

7.1-preview.1

Esegue una pipeline.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
pipelineId	path	True	integer int32	ID della pipeline.
project	path	True	string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.1' per usare questa versione dell'API.
pipelineVersion	query		integer int32	Versione della pipeline.

Corpo della richiesta

Nome	Tipo	Descrizione
previewRun	boolean	Se true, non creare effettivamente una nuova esecuzione. Restituire invece il documento YAML finale dopo l'analisi dei modelli.
resources	RunResourcesParameters	Le risorse necessarie per l'esecuzione.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Se si usa l'opzione di esecuzione di anteprima, è possibile specificare yaML diverso. In questo modo è possibile visualizzare in anteprima il documento YAML finale senza eseguire il commit di un file modificato.

Risposte

Nome	Tipo	Descrizione
200 OK	Run	operazione riuscita

Sicurezza

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

Nome	Descrizione
vso.build_execute	Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati della compilazione, le definizioni e le richieste e la possibilità di accodare una compilazione, aggiornare le proprietà di compilazione e la possibilità di ricevere notifiche sugli eventi di compilazione tramite hook del servizio.

Definizioni

Nome	Descrizione
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference	Riferimento a una pipeline.
PipelineResource
PipelineResourceParameters
ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters	Impostazioni che influiscono sulle esecuzioni della pipeline.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Nome	Tipo	Descrizione
version	string

Container

Nome	Tipo	Descrizione
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

Nome	Tipo	Descrizione
container	Container

ContainerResourceParameters

Nome	Tipo	Descrizione
version	string

PackageResourceParameters

Nome	Tipo	Descrizione
version	string

PipelineReference

Riferimento a una pipeline.

Nome	Tipo	Descrizione
folder	string	Cartella della pipeline
id	integer	Pipeline ID
name	string	Nome della pipeline
revision	integer	Numero di revisione
url	string

PipelineResource

Nome	Tipo	Descrizione
pipeline	PipelineReference	Riferimento a una pipeline.
version	string

PipelineResourceParameters

Nome	Tipo	Descrizione
version	string

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

Repository

Nome	Tipo	Descrizione
type	RepositoryType

RepositoryResource

Nome	Tipo	Descrizione
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Nome	Tipo	Descrizione
refName	string
token	string	Si tratta del token di sicurezza da usare durante la connessione al repository.
tokenType	string	Facoltativa. Questo è il tipo del token specificato. Se non specificato, viene assunto un tipo di "Orso". Nota: usare "Basic" per un token PAT.
version	string

RepositoryType

Nome	Tipo	Descrizione
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

Nome	Tipo	Descrizione
_links	ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
createdDate	string
finalYaml	string
finishedDate	string
id	integer
name	string
pipeline	PipelineReference	Riferimento a una pipeline.
resources	RunResources
result	RunResult
state	RunState
templateParameters	object
url	string
variables	<string,  Variable>

RunPipelineParameters

Impostazioni che influiscono sulle esecuzioni della pipeline.

Nome	Tipo	Descrizione
previewRun	boolean	Se true, non creare effettivamente una nuova esecuzione. Restituire invece il documento YAML finale dopo l'analisi dei modelli.
resources	RunResourcesParameters	Le risorse necessarie per l'esecuzione.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Se si usa l'opzione di esecuzione di anteprima, è possibile specificare yaML diverso. In questo modo è possibile visualizzare in anteprima il documento YAML finale senza eseguire il commit di un file modificato.

RunResources

Nome	Tipo	Descrizione
containers	<string,  ContainerResource>
pipelines	<string,  PipelineResource>
repositories	<string,  RepositoryResource>

RunResourcesParameters

Nome	Tipo	Descrizione
builds	<string,  BuildResourceParameters>
containers	<string,  ContainerResourceParameters>
packages	<string,  PackageResourceParameters>
pipelines	<string,  PipelineResourceParameters>
repositories	<string,  RepositoryResourceParameters>

RunResult

Nome	Tipo	Descrizione
canceled	string
failed	string
succeeded	string
unknown	string

RunState

Nome	Tipo	Descrizione
canceling	string
completed	string
inProgress	string
unknown	string

Variable

Nome	Tipo	Descrizione
isSecret	boolean
value	string