Runs - Run Pipeline

Service:

Pipelines

API Version:

6.1-preview.1

Ejecuta una canalización.

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=6.1-preview.1

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?pipelineVersion={pipelineVersion}&api-version=6.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 "6.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, no cree realmente 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, opcionalmente puede proporcionar yaML diferente. Esto le permite obtener una vista previa del documento YAML final sin confirmar un archivo modificado.

Respuestas

Nombre	Tipo	Description
200 OK	Run	operación correcta

Seguridad

accessToken

Token de acceso personal. Use cualquier valor para el nombre de usuario y el token como contraseña.

Type: basic

Definiciones

Nombre	Description
BuildResourceParameters
ContainerResourceParameters
PackageResourceParameters
PipelineReference	Referencia a una canalización.
PipelineResourceParameters
ReferenceLinks	Clase que se va a representar 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

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	Identificador de canalización
name	string	Nombre de la canalización
revision	integer	Número de revisión
url	string

PipelineResourceParameters

Nombre	Tipo	Description
version	string

ReferenceLinks

Clase que se va a representar una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de 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 va a 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 se va a representar 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
url	string
variables	<string,  Variable>

RunPipelineParameters

Configuración que influye 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 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, opcionalmente puede proporcionar yaML diferente. Esto le permite obtener una vista previa del documento YAML final sin confirmar un archivo modificado.

RunResources

Nombre	Tipo	Description
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