PipelinesRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Pipelines |
Métodos
| create |
Creación de una canalización |
| get |
Obtención de un artefacto específico de una ejecución de canalización |
| get |
Obtención de un registro específico de una ejecución de canalización |
| get |
Obtiene una canalización, opcionalmente en la versión especificada. |
| get |
Obtiene una ejecución para una canalización determinada. |
| list |
Obtenga una lista de registros de una ejecución de canalización. |
| list |
Obtenga una lista de canalizaciones. |
| list |
Obtiene las 10000 ejecuciones principales de una canalización determinada. |
| preview(Run |
Pone en cola una ejecución en seco de la canalización y devuelve un objeto que contiene el yaml final. |
| run |
Ejecuta una canalización. |
Detalles del constructor
PipelinesRestClient(IVssRestClientOptions)
Detalles del método
createPipeline(CreatePipelineParameters, string)
Creación de una canalización
function createPipeline(inputParameters: CreatePipelineParameters, project: string): Promise<Pipeline>Parámetros
- inputParameters
- CreatePipelineParameters
Parámetros de entrada.
- project
-
string
Id. de proyecto o nombre del proyecto
Devoluciones
Promise<Pipeline>
getArtifact(string, number, number, string, GetArtifactExpandOptions)
Obtención de un artefacto específico de una ejecución de canalización
function getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: GetArtifactExpandOptions): Promise<Artifact>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- pipelineId
-
number
Identificador de la canalización.
- runId
-
number
Identificador de la ejecución de esa canalización.
- artifactName
-
string
Nombre del artefacto.
- expand
- GetArtifactExpandOptions
Expanda opciones. El valor predeterminado es None.
Devoluciones
Promise<Artifact>
getLog(string, number, number, number, GetLogExpandOptions)
Obtención de un registro específico de una ejecución de canalización
function getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: GetLogExpandOptions): Promise<Log>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- pipelineId
-
number
Identificador de la canalización.
- runId
-
number
Identificador de la ejecución de esa canalización.
- logId
-
number
Identificador del registro.
- expand
- GetLogExpandOptions
Expanda opciones. El valor predeterminado es None.
Devoluciones
Promise<Log>
getPipeline(string, number, number)
Obtiene una canalización, opcionalmente en la versión especificada.
function getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipeline>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- pipelineId
-
number
Identificador de canalización
- pipelineVersion
-
number
La versión de la canalización
Devoluciones
Promise<Pipeline>
getRun(string, number, number)
Obtiene una ejecución para una canalización determinada.
function getRun(project: string, pipelineId: number, runId: number): Promise<Run>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- pipelineId
-
number
Identificador de canalización
- runId
-
number
Identificador de ejecución
Devoluciones
Promise<Run>
listLogs(string, number, number, GetLogExpandOptions)
Obtenga una lista de registros de una ejecución de canalización.
function listLogs(project: string, pipelineId: number, runId: number, expand?: GetLogExpandOptions): Promise<LogCollection>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- pipelineId
-
number
Identificador de la canalización.
- runId
-
number
Identificador de la ejecución de esa canalización.
- expand
- GetLogExpandOptions
Expanda opciones. El valor predeterminado es None.
Devoluciones
Promise<LogCollection>
listPipelines(string, string, number, string)
Obtenga una lista de canalizaciones.
function listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipeline[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- orderBy
-
string
Expresión de ordenación. El valor predeterminado es "name asc"
- top
-
number
Número máximo de canalizaciones que se van a devolver
- continuationToken
-
string
Un token de continuación de una solicitud anterior, para recuperar la página siguiente de resultados
Devoluciones
Promise<Pipeline[]>
listRuns(string, number)
Obtiene las 10000 ejecuciones principales de una canalización determinada.
function listRuns(project: string, pipelineId: number): Promise<Run[]>Parámetros
- project
-
string
Id. de proyecto o nombre del proyecto
- pipelineId
-
number
Identificador de canalización
Devoluciones
Promise<Run[]>
preview(RunPipelineParameters, string, number, number)
Pone en cola una ejecución en seco de la canalización y devuelve un objeto que contiene el yaml final.
function preview(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<PreviewRun>Parámetros
- runParameters
- RunPipelineParameters
Parámetros adicionales opcionales para esta ejecución.
- project
-
string
Id. de proyecto o nombre del proyecto
- pipelineId
-
number
Identificador de canalización.
- pipelineVersion
-
number
La versión de canalización.
Devoluciones
Promise<PreviewRun>
runPipeline(RunPipelineParameters, string, number, number)
Ejecuta una canalización.
function runPipeline(runParameters: RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Run>Parámetros
- runParameters
- RunPipelineParameters
Parámetros adicionales opcionales para esta ejecución.
- project
-
string
Id. de proyecto o nombre del proyecto
- pipelineId
-
number
Identificador de canalización.
- pipelineVersion
-
number
La versión de canalización.
Devoluciones
Promise<Run>