Runs - Run Pipeline
Runs a pipeline.
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=7.0
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=7.0
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
pipeline
|
path | True |
integer int32 |
The pipeline ID. |
project
|
path | True |
string |
Project ID or project name |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.0' to use this version of the api. |
pipeline
|
query |
integer int32 |
The pipeline version. |
Name | Type | Description |
---|---|---|
previewRun |
boolean |
If true, don't actually create a new run. Instead, return the final YAML document after parsing templates. |
resources |
The resources the run requires. |
|
stagesToSkip |
string[] |
|
templateParameters |
object |
|
variables |
<string, Variable> |
|
yamlOverride |
string |
If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file. |
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Personal access token. Use any value for the user name and the token as the password.
Type:
basic
Name | Description |
---|---|
Build |
|
Container |
|
Package |
|
Pipeline |
A reference to a Pipeline. |
Pipeline |
|
Reference |
The class to represent a collection of REST reference links. |
Repository | |
Repository |
|
Repository |
|
Repository |
|
Run | |
Run |
Settings which influence pipeline runs. |
Run |
|
Run |
|
Run |
|
Run |
|
Variable |
Name | Type | Description |
---|---|---|
version |
string |
Name | Type | Description |
---|---|---|
version |
string |
Name | Type | Description |
---|---|---|
version |
string |
A reference to a Pipeline.
Name | Type | Description |
---|---|---|
folder |
string |
Pipeline folder |
id |
integer |
Pipeline ID |
name |
string |
Pipeline name |
revision |
integer |
Revision number |
url |
string |
Name | Type | Description |
---|---|---|
version |
string |
The class to represent a collection of REST reference links.
Name | Type | Description |
---|---|---|
links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
Name | Type | Description |
---|---|---|
type |
Name | Type | Description |
---|---|---|
refName |
string |
|
repository | ||
version |
string |
Name | Type | Description |
---|---|---|
refName |
string |
|
token |
string |
This is the security token to use when connecting to the repository. |
tokenType |
string |
Optional. This is the type of the token given. If not provided, a type of "Bearer" is assumed. Note: Use "Basic" for a PAT token. |
version |
string |
Name | Type | Description |
---|---|---|
azureReposGit |
string |
|
azureReposGitHyphenated |
string |
|
gitHub |
string |
|
gitHubEnterprise |
string |
|
unknown |
string |
Name | Type | Description |
---|---|---|
_links |
The class to represent a collection of REST reference links. |
|
createdDate |
string |
|
finalYaml |
string |
|
finishedDate |
string |
|
id |
integer |
|
name |
string |
|
pipeline |
A reference to a Pipeline. |
|
resources | ||
result | ||
state | ||
url |
string |
|
variables |
<string, Variable> |
Settings which influence pipeline runs.
Name | Type | Description |
---|---|---|
previewRun |
boolean |
If true, don't actually create a new run. Instead, return the final YAML document after parsing templates. |
resources |
The resources the run requires. |
|
stagesToSkip |
string[] |
|
templateParameters |
object |
|
variables |
<string, Variable> |
|
yamlOverride |
string |
If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file. |
Name | Type | Description |
---|---|---|
repositories |
<string,
Repository |
Name | Type | Description |
---|---|---|
builds |
<string,
Build |
|
containers |
<string,
Container |
|
packages |
<string,
Package |
|
pipelines |
<string,
Pipeline |
|
repositories |
<string,
Repository |
Name | Type | Description |
---|---|---|
canceled |
string |
|
failed |
string |
|
succeeded |
string |
|
unknown |
string |
Name | Type | Description |
---|---|---|
canceling |
string |
|
completed |
string |
|
inProgress |
string |
|
unknown |
string |
Name | Type | Description |
---|---|---|
isSecret |
boolean |
|
value |
string |