Compartir a través de


Runs - Run Pipeline

Ejecuta una canalización.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
organization
path True

string

El nombre de la organización de Azure DevOps.

pipelineId
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-preview.1" para usar esta versión de la API.

pipelineVersion
query

integer

int32

La versión de canalización.

Cuerpo de la solicitud

Nombre Tipo Description
previewRun

boolean

Si es true, en realidad no cree una nueva ejecución. En su lugar, devuelva el documento YAML final después de analizar las plantillas.

resources

RunResourcesParameters

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 un yaML diferente. Esto le permite obtener una vista previa del documento YAML final sin confirmar un archivo cambiado.

Respuestas

Nombre Tipo Description
200 OK

Run

operación correcta

Seguridad

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

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
BuildResourceParameters
Container
ContainerResource
ContainerResourceParameters
PackageResourceParameters
PipelineReference

Referencia a una canalización.

PipelineResource
PipelineResourceParameters
ReferenceLinks

Clase que representa una colección de vínculos de referencia de REST.

Repository
RepositoryResource
RepositoryResourceParameters
RepositoryType
Run
RunPipelineParameters

Configuración que influye en las ejecuciones de canalización.

RunResources
RunResourcesParameters
RunResult
RunState
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

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

Id. de canalización

name

string

Nombre de la canalización

revision

integer

Número de revisión

url

string

PipelineResource

Nombre Tipo Description
pipeline

PipelineReference

Referencia a una canalización.

version

string

PipelineResourceParameters

Nombre Tipo Description
version

string

Clase que representa una colección de vínculos de referencia de 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

RepositoryType

RepositoryResource

Nombre Tipo Description
refName

string

repository

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

Nombre Tipo Description
azureReposGit

string

azureReposGitHyphenated

string

gitHub

string

gitHubEnterprise

string

unknown

string

Run

Nombre Tipo Description
_links

ReferenceLinks

Clase que representa una colección de vínculos de referencia de REST.

createdDate

string

finalYaml

string

finishedDate

string

id

integer

name

string

pipeline

PipelineReference

Referencia a una canalización.

resources

RunResources

result

RunResult

state

RunState

templateParameters

object

url

string

variables

<string,  Variable>

RunPipelineParameters

Configuración que influye en las ejecuciones de canalización.

Nombre Tipo Description
previewRun

boolean

Si es true, en realidad no cree una nueva ejecución. En su lugar, devuelva el documento YAML final después de analizar las plantillas.

resources

RunResourcesParameters

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 un yaML diferente. Esto le permite obtener una vista previa del documento YAML final sin confirmar un archivo cambiado.

RunResources

Nombre Tipo Description
containers

<string,  ContainerResource>

pipelines

<string,  PipelineResource>

repositories

<string,  RepositoryResource>

RunResourcesParameters

Nombre Tipo Description
builds

<string,  BuildResourceParameters>

containers

<string,  ContainerResourceParameters>

packages

<string,  PackageResourceParameters>

pipelines

<string,  PipelineResourceParameters>

repositories

<string,  RepositoryResourceParameters>

RunResult

Nombre Tipo Description
canceled

string

failed

string

succeeded

string

unknown

string

RunState

Nombre Tipo Description
canceling

string

completed

string

inProgress

string

unknown

string

Variable

Nombre Tipo Description
isSecret

boolean

value

string