Runs - Run Pipeline

Service:

Pipelines

Version d'API:

6.1-preview.1

Exécute un pipeline.

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

Avec des paramètres facultatifs:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=6.1-preview.1

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
pipelineId	path	True	integer int32	ID de pipeline.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 6.1-preview.1 » pour utiliser cette version de l’API.
pipelineVersion	query		integer int32	Version du pipeline.

Corps de la demande

Nom	Type	Description
previewRun	boolean	Si la valeur est true, ne créez pas réellement d’exécution. Au lieu de cela, retournez le document YAML final après l’analyse des modèles.
resources	RunResourcesParameters	Ressources dont l’exécution a besoin.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Si vous utilisez l’option d’exécution en préversion, vous pouvez éventuellement fournir un autre YAML. Cela vous permet d’afficher un aperçu du document YAML final sans valider de fichier modifié.

Réponses

Nom	Type	Description
200 OK	Run	opération réussie

Sécurité

accessToken

Jeton d’accès personnel. Utilisez n’importe quelle valeur pour le nom d’utilisateur et le jeton comme mot de passe.

Type: basic

Définitions

Nom	Description
BuildResourceParameters
ContainerResourceParameters
PackageResourceParameters
PipelineReference	Référence à un pipeline.
PipelineResourceParameters
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters	Paramètres qui influencent les exécutions de pipeline.
RunResources
RunResourcesParameters
RunResult
RunState
Variable

BuildResourceParameters

Object

Nom	Type	Description
version	string

ContainerResourceParameters

Object

Nom	Type	Description
version	string

PackageResourceParameters

Object

Nom	Type	Description
version	string

PipelineReference

Object

Référence à un pipeline.

Nom	Type	Description
folder	string	Dossier de pipeline
id	integer	ID du pipeline
name	string	Nom du pipeline
revision	integer	Numéro de révision
url	string

PipelineResourceParameters

Object

Nom	Type	Description
version	string

ReferenceLinks

Object

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

Repository

Object

Nom	Type	Description
type	RepositoryType

RepositoryResource

Object

Nom	Type	Description
refName	string
repository	Repository
version	string

RepositoryResourceParameters

Object

Nom	Type	Description
refName	string
token	string	Il s’agit du jeton de sécurité à utiliser lors de la connexion au dépôt.
tokenType	string	facultatif. Il s’agit du type du jeton donné. S’il n’est pas fourni, un type de « porteur » est supposé. Remarque : Utilisez « De base » pour un jeton PAT.
version	string

RepositoryType

Enumeration

Valeur	Description
azureReposGit
azureReposGitHyphenated
gitHub
gitHubEnterprise
unknown

Run

Object

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
createdDate	string
finalYaml	string
finishedDate	string
id	integer
name	string
pipeline	PipelineReference	Référence à un pipeline.
resources	RunResources
result	RunResult
state	RunState
url	string
variables	<string,  Variable>

RunPipelineParameters

Object

Paramètres qui influencent les exécutions de pipeline.

Nom	Type	Description
previewRun	boolean	Si la valeur est true, ne créez pas réellement d’exécution. Au lieu de cela, retournez le document YAML final après l’analyse des modèles.
resources	RunResourcesParameters	Ressources dont l’exécution a besoin.
stagesToSkip	string[]
templateParameters	object
variables	<string,  Variable>
yamlOverride	string	Si vous utilisez l’option d’exécution en préversion, vous pouvez éventuellement fournir un autre YAML. Cela vous permet d’afficher un aperçu du document YAML final sans valider de fichier modifié.

RunResources

Object

Nom	Type	Description
repositories	<string,  RepositoryResource>

RunResourcesParameters

Object

Nom	Type	Description
builds	<string,  BuildResourceParameters>
containers	<string,  ContainerResourceParameters>
packages	<string,  PackageResourceParameters>
pipelines	<string,  PipelineResourceParameters>
repositories	<string,  RepositoryResourceParameters>

RunResult

Enumeration

Valeur	Description
canceled
failed
succeeded
unknown

RunState

Enumeration

Valeur	Description
canceling
completed
inProgress
unknown

Variable

Object

Nom	Type	Description
isSecret	boolean
value	string