Runs - Run Pipeline

Référence

Service:: Pipelines

API Version:: 7.1-preview.1

Exécute un 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

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 « 7.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 d’exécution. Au lieu de cela, retournez le document YAML final après l’analyse des modèles.
resources	RunResourcesParameters	Ressources requises par l’exécution.
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 un fichier modifié.

Réponses

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

Sécurité

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

Nom	Description
vso.build_execute	Accorde la possibilité d’accéder aux artefacts de build, y compris les résultats de build, les définitions et les demandes, ainsi que la possibilité de mettre en file d’attente une build, de mettre à jour les propriétés de build et de recevoir des notifications sur les événements de build via des hooks de service.

Définitions

Nom	Description
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference	Référence à un pipeline.
PipelineResource
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

Nom	Type	Description
version	string

Container

Nom	Type	Description
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

Nom	Type	Description
container	Container

ContainerResourceParameters

Nom	Type	Description
version	string

PackageResourceParameters

Nom	Type	Description
version	string

PipelineReference

Référence à un pipeline.

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

PipelineResource

Nom	Type	Description
pipeline	PipelineReference	Référence à un pipeline.
version	string

PipelineResourceParameters

Nom	Type	Description
version	string

ReferenceLinks

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 de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

Repository

Nom	Type	Description
type	RepositoryType

RepositoryResource

Nom	Type	Description
refName	string
repository	Repository
version	string

RepositoryResourceParameters

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

Nom	Type	Description
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

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
templateParameters	object
url	string
variables	<string, Variable>

RunPipelineParameters

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

Nom	Type	Description
previewRun	boolean	Si la valeur est true, ne créez pas d’exécution. Au lieu de cela, retournez le document YAML final après l’analyse des modèles.
resources	RunResourcesParameters	Ressources requises par l’exécution.
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 un fichier modifié.

RunResources

Nom	Type	Description
containers	<string, ContainerResource>
pipelines	<string, PipelineResource>
repositories	<string, RepositoryResource>

RunResourcesParameters

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

RunResult

Nom	Type	Description
canceled	string
failed	string
succeeded	string
unknown	string

RunState

Nom	Type	Description
canceling	string
completed	string
inProgress	string
unknown	string

Variable

Nom	Type	Description
isSecret	boolean
value	string

Partager via