Runs - Run Pipeline
Exécute un pipeline.
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.1POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.1Paramè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 » 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 réellement 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 différents 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
Flux:
accessCode
URL d’autorisation:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton:
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
Étendues
| Nom | Description |
|---|---|
| vso.build_execute | Accorde la possibilité d’accéder aux artefacts de build, notamment 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 génération via des hooks de service. |
Définitions
| Nom | Description |
|---|---|
|
Build |
|
| Container | |
|
Container |
|
|
Container |
|
|
Package |
|
|
Pipeline |
Référence à un pipeline. |
|
Pipeline |
|
|
Pipeline |
|
|
Reference |
Classe à représenter une collection de liens de référence REST. |
| Repository | |
|
Repository |
|
|
Repository |
|
|
Repository |
|
| Run | |
|
Run |
Paramètres qui influencent les exécutions du 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 de pipeline |
| id |
integer (int32) |
Pipeline ID |
| name |
string |
Nom du pipeline |
| revision |
integer (int32) |
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 à 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 référentiel. |
| tokenType |
string |
Optionnel. 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
| Valeur | Description |
|---|---|
| azureReposGit | |
| azureReposGitHyphenated | |
| gitHub | |
| gitHubEnterprise | |
| unknown |
Run
| Nom | Type | Description |
|---|---|---|
| _links |
Classe à représenter une collection de liens de référence REST. |
|
| createdDate |
string (date-time) |
|
| finalYaml |
string |
|
| finishedDate |
string (date-time) |
|
| id |
integer (int32) |
|
| 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 du 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 |
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 différents 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
| Valeur | Description |
|---|---|
| canceled | |
| failed | |
| succeeded | |
| unknown |
RunState
| Valeur | Description |
|---|---|
| canceling | |
| completed | |
| inProgress | |
| unknown |
Variable
| Nom | Type | Description |
|---|---|---|
| isSecret |
boolean |
|
| value |
string |