Runs - Run Pipeline
Ejecuta una canalización.
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.1Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Nombre de la organización de Azure DevOps. |
|
pipeline
|
path | True |
integer (int32) |
Identificador de canalización. |
|
project
|
path | True |
string |
Id. de proyecto o nombre del proyecto |
|
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API. |
|
pipeline
|
query |
integer (int32) |
Versión de la canalización. |
Cuerpo de la solicitud
| Nombre | Tipo | Description |
|---|---|---|
| previewRun |
boolean |
Si es true, no cree realmente una nueva ejecución. En su lugar, devuelva el documento YAML final después de analizar plantillas. |
| resources |
Los recursos que requiere la ejecución. |
|
| stagesToSkip |
string[] |
|
| templateParameters |
object |
|
| variables |
<string, Variable> |
|
| yamlOverride |
string |
Si usa la opción de ejecución en versión preliminar, puede proporcionar opcionalmente diferentes YAML. Esto le permite obtener una vista previa del documento YAML final sin confirmar un archivo modificado. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
operación correcta |
Seguridad
oauth2
Tipo:
oauth2
Flujo:
accessCode
Dirección URL de autorización:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token:
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
Ámbitos
| Nombre | Description |
|---|---|
| vso.build_execute | Concede la capacidad de acceder a los artefactos de compilación, incluidos los resultados de compilación, las definiciones y las solicitudes, y la capacidad de poner en cola una compilación, actualizar las propiedades de compilación y la capacidad de recibir notificaciones sobre eventos de compilación a través de enlaces de servicio. |
Definiciones
| Nombre | Description |
|---|---|
|
Build |
|
| Container | |
|
Container |
|
|
Container |
|
|
Package |
|
|
Pipeline |
Referencia a una canalización. |
|
Pipeline |
|
|
Pipeline |
|
|
Reference |
Clase que representa una colección de vínculos de referencia rest. |
| Repository | |
|
Repository |
|
|
Repository |
|
|
Repository |
|
| Run | |
|
Run |
Configuración que influyen en las ejecuciones de canalización. |
|
Run |
|
|
Run |
|
|
Run |
|
|
Run |
|
| Variable |
BuildResourceParameters
| Nombre | Tipo | Description |
|---|---|---|
| version |
string |
Container
| Nombre | Tipo | Description |
|---|---|---|
| environment |
object |
|
| image |
string |
|
| mapDockerSocket |
boolean |
|
| options |
string |
|
| ports |
string[] |
|
| volumes |
string[] |
ContainerResource
| Nombre | Tipo | Description |
|---|---|---|
| container |
ContainerResourceParameters
| Nombre | Tipo | Description |
|---|---|---|
| version |
string |
PackageResourceParameters
| Nombre | Tipo | Description |
|---|---|---|
| version |
string |
PipelineReference
Referencia a una canalización.
| Nombre | Tipo | Description |
|---|---|---|
| folder |
string |
Carpeta de canalización |
| id |
integer (int32) |
Id. de canalización |
| name |
string |
Nombre de canalización |
| revision |
integer (int32) |
Número de revisión |
| url |
string |
PipelineResource
| Nombre | Tipo | Description |
|---|---|---|
| pipeline |
Referencia a una canalización. |
|
| version |
string |
PipelineResourceParameters
| Nombre | Tipo | Description |
|---|---|---|
| version |
string |
ReferenceLinks
Clase que representa una colección de vínculos de referencia rest.
| Nombre | Tipo | Description |
|---|---|---|
| links |
object |
Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |
Repository
| Nombre | Tipo | Description |
|---|---|---|
| type |
RepositoryResource
| Nombre | Tipo | Description |
|---|---|---|
| refName |
string |
|
| repository | ||
| version |
string |
RepositoryResourceParameters
| Nombre | Tipo | Description |
|---|---|---|
| refName |
string |
|
| token |
string |
Este es el token de seguridad que se usará al conectarse al repositorio. |
| tokenType |
string |
Opcional. Este es el tipo del token especificado. Si no se proporciona, se supone un tipo de "Portador". Nota: Use "Basic" para un token PAT. |
| version |
string |
RepositoryType
| Valor | Description |
|---|---|
| azureReposGit | |
| azureReposGitHyphenated | |
| gitHub | |
| gitHubEnterprise | |
| unknown |
Run
| Nombre | Tipo | Description |
|---|---|---|
| _links |
Clase que representa una colección de vínculos de referencia rest. |
|
| createdDate |
string (date-time) |
|
| finalYaml |
string |
|
| finishedDate |
string (date-time) |
|
| id |
integer (int32) |
|
| name |
string |
|
| pipeline |
Referencia a una canalización. |
|
| resources | ||
| result | ||
| state | ||
| templateParameters |
object |
|
| url |
string |
|
| variables |
<string, Variable> |
RunPipelineParameters
Configuración que influyen en las ejecuciones de canalización.
| Nombre | Tipo | Description |
|---|---|---|
| previewRun |
boolean |
Si es true, no cree realmente una nueva ejecución. En su lugar, devuelva el documento YAML final después de analizar plantillas. |
| resources |
Los recursos que requiere la ejecución. |
|
| stagesToSkip |
string[] |
|
| templateParameters |
object |
|
| variables |
<string, Variable> |
|
| yamlOverride |
string |
Si usa la opción de ejecución en versión preliminar, puede proporcionar opcionalmente diferentes YAML. Esto le permite obtener una vista previa del documento YAML final sin confirmar un archivo modificado. |
RunResources
| Nombre | Tipo | Description |
|---|---|---|
| containers |
<string,
Container |
|
| pipelines |
<string,
Pipeline |
|
| repositories |
<string,
Repository |
RunResourcesParameters
| Nombre | Tipo | Description |
|---|---|---|
| builds |
<string,
Build |
|
| containers |
<string,
Container |
|
| packages |
<string,
Package |
|
| pipelines |
<string,
Pipeline |
|
| repositories |
<string,
Repository |
RunResult
| Valor | Description |
|---|---|
| canceled | |
| failed | |
| succeeded | |
| unknown |
RunState
| Valor | Description |
|---|---|
| canceling | |
| completed | |
| inProgress | |
| unknown |
Variable
| Nombre | Tipo | Description |
|---|---|---|
| isSecret |
boolean |
|
| value |
string |