Runs - Run Pipeline
Exécute un pipeline.
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1-preview.1
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. |
pipeline
|
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. |
pipeline
|
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 |
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 |
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 |
---|---|
Build |
|
Container | |
Container |
|
Container |
|
Package |
|
Pipeline |
Référence à un pipeline. |
Pipeline |
|
Pipeline |
|
Reference |
Classe pour représenter une collection de liens de référence REST. |
Repository | |
Repository |
|
Repository |
|
Repository |
|
Run | |
Run |
Paramètres qui influencent les exécutions de pipeline. |
Run |
|
Run |
|
Run |
|
Run |
|
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 |
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 |
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 |
RepositoryResource
Nom | Type | Description |
---|---|---|
refName |
string |
|
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 |
Classe pour représenter une collection de liens de référence REST. |
|
createdDate |
string |
|
finalYaml |
string |
|
finishedDate |
string |
|
id |
integer |
|
name |
string |
|
pipeline |
Référence à un pipeline. |
|
resources | ||
result | ||
state | ||
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 |
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,
Container |
|
pipelines |
<string,
Pipeline |
|
repositories |
<string,
Repository |
RunResourcesParameters
Nom | Type | Description |
---|---|---|
builds |
<string,
Build |
|
containers |
<string,
Container |
|
packages |
<string,
Package |
|
pipelines |
<string,
Pipeline |
|
repositories |
<string,
Repository |
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 |
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour