Class PipelinesApi

Hierarchy (View Summary)

ClientApiBase
- PipelinesApi

Implements

IPipelinesApi

Index

Constructors

constructor

new PipelinesApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): PipelinesApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns PipelinesApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:33

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of IPipelinesApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createPipeline

createPipeline(
inputParameters: CreatePipelineParameters,
project: string,
): Promise<Pipeline>
Create a pipeline.
Parameters
- inputParameters: CreatePipelineParameters
  Input parameters.
- project: string
  Project ID or project name
Returns Promise<Pipeline>
Implementation of IPipelinesApi.createPipeline
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:214

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of IPipelinesApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of IPipelinesApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getArtifact

getArtifact(
    project: string,
    pipelineId: number,
    runId: number,
    artifactName: string,
    expand?: GetArtifactExpandOptions,
): Promise<Artifact>
Get a specific artifact from a pipeline run
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  ID of the pipeline.
- runId: number
  ID of the run of that pipeline.
- artifactName: string
  Name of the artifact.
- Optionalexpand: GetArtifactExpandOptions
  Expand options. Default is None.
Returns Promise<Artifact>
Implementation of IPipelinesApi.getArtifact
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:46

getLog

getLog(
    project: string,
    pipelineId: number,
    runId: number,
    logId: number,
    expand?: GetLogExpandOptions,
): Promise<Log>
Get a specific log from a pipeline run
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  ID of the pipeline.
- runId: number
  ID of the run of that pipeline.
- logId: number
  ID of the log.
- Optionalexpand: GetLogExpandOptions
  Expand options. Default is None.
Returns Promise<Log>
Implementation of IPipelinesApi.getLog
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:106

getPipeline

getPipeline(
    project: string,
    pipelineId: number,
    pipelineVersion?: number,
): Promise<Pipeline>
Gets a pipeline, optionally at the specified version
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  The pipeline ID
- OptionalpipelineVersion: number
  The pipeline version
Returns Promise<Pipeline>
Implementation of IPipelinesApi.getPipeline
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:258

getRun

getRun(project: string, pipelineId: number, runId: number): Promise<Run>
Gets a run for a particular pipeline.
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  The pipeline id
- runId: number
  The run id
Returns Promise<Run>
Implementation of IPipelinesApi.getRun
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:416

listLogs

listLogs(
    project: string,
    pipelineId: number,
    runId: number,
    expand?: GetLogExpandOptions,
): Promise<LogCollection>
Get a list of logs from a pipeline run.
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  ID of the pipeline.
- runId: number
  ID of the run of that pipeline.
- Optionalexpand: GetLogExpandOptions
  Expand options. Default is None.
Returns Promise<LogCollection>
Implementation of IPipelinesApi.listLogs
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:162

listPipelines

listPipelines(
    project: string,
    orderBy?: string,
    top?: number,
    continuationToken?: string,
): Promise<Pipeline[]>
Get a list of pipelines.
Parameters
- project: string
  Project ID or project name
- OptionalorderBy: string
  A sort expression. Defaults to "name asc"
- Optionaltop: number
  The maximum number of pipelines to return
- OptionalcontinuationToken: string
  A continuation token from a previous request, to retrieve the next page of results
Returns Promise<Pipeline[]>
Implementation of IPipelinesApi.listPipelines
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:310

listRuns

listRuns(project: string, pipelineId: number): Promise<Run[]>
Gets top 10000 runs for a particular pipeline.
Parameters
- project: string
  Project ID or project name
- pipelineId: number
  The pipeline id
Returns Promise<Run[]>
Implementation of IPipelinesApi.listRuns
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:462

preview

preview(
    runParameters: RunPipelineParameters,
    project: string,
    pipelineId: number,
    pipelineVersion?: number,
): Promise<PreviewRun>
Queues a dry run of the pipeline and returns an object containing the final yaml.
Parameters
- runParameters: RunPipelineParameters
  Optional additional parameters for this run.
- project: string
  Project ID or project name
- pipelineId: number
  The pipeline ID.
- OptionalpipelineVersion: number
  The pipeline version.
Returns Promise<PreviewRun>
Implementation of IPipelinesApi.preview
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:364

runPipeline

runPipeline(
    runParameters: RunPipelineParameters,
    project: string,
    pipelineId: number,
    pipelineVersion?: number,
): Promise<Run>
Runs a pipeline.
Parameters
- runParameters: RunPipelineParameters
  Optional additional parameters for this run.
- project: string
  Project ID or project name
- pipelineId: number
  The pipeline ID.
- OptionalpipelineVersion: number
  The pipeline version.
Returns Promise<Run>
Implementation of IPipelinesApi.runPipeline
- Defined in repos/azure-devops-node-api/api/PipelinesApi.ts:508

Class PipelinesApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PipelinesApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Methods

createAcceptHeader

Parameters

Returns string

createPipeline

Parameters

Returns Promise<Pipeline>

createRequestOptions

Parameters

Returns IRequestOptions

formatResponse

Parameters

Returns any

getArtifact

Parameters

Returns Promise<Artifact>

getLog

Parameters

Returns Promise<Log>

getPipeline

Parameters

Returns Promise<Pipeline>

getRun

Parameters

Returns Promise<Run>

listLogs

Parameters

Returns Promise<LogCollection>

listPipelines

Parameters

Returns Promise<Pipeline[]>

listRuns

Parameters

Returns Promise<Run[]>

preview

Parameters

Returns Promise<PreviewRun>

runPipeline

Parameters

Returns Promise<Run>

Settings

On This Page