Runs - Run Pipeline

Servizio:

Pipelines

Versione API:

7.1

Esegue una pipeline.

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

Con parametri facoltativi:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.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. Deve essere impostato su '7.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, facoltativamente è 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

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Ambiti

Nome	Descrizione
vso.build_execute	Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati di 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 per rappresentare una raccolta di collegamenti di riferimento REST.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters	Impostazioni che influenzano le esecuzioni della pipeline.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Object

Nome	Tipo	Descrizione
version	string

Container

Object

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

ContainerResource

Object

Nome	Tipo	Descrizione
container	Container

ContainerResourceParameters

Object

Nome	Tipo	Descrizione
version	string

PackageResourceParameters

Object

Nome	Tipo	Descrizione
version	string

PipelineReference

Object

Riferimento a una pipeline.

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

PipelineResource

Object

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

PipelineResourceParameters

Object

Nome	Tipo	Descrizione
version	string

ReferenceLinks

Object

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

Repository

Object

Nome	Tipo	Descrizione
type	RepositoryType

RepositoryResource

Object

Nome	Tipo	Descrizione
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Object

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

RepositoryType

Enumerazione

Valore	Descrizione
azureReposGit
azureReposGitHyphenated
gitHub
gitHubEnterprise
unknown

Run

Object

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

RunPipelineParameters

Object

Impostazioni che influenzano le 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, facoltativamente è possibile specificare YAML diverso. In questo modo è possibile visualizzare in anteprima il documento YAML finale senza eseguire il commit di un file modificato.

RunResources

Object

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

RunResourcesParameters

Object

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

RunResult

Enumerazione

Valore	Descrizione
canceled
failed
succeeded
unknown

RunState

Enumerazione

Valore	Descrizione
canceling
completed
inProgress
unknown

Variable

Object

Nome	Tipo	Descrizione
isSecret	boolean
value	string