Interface PipelineRunOperations

Package version

Interface representing a PipelineRunOperations.

Hierarchy

PipelineRunOperations

Implemented by

PipelineRunOperationsImpl

Index

Methods

Methods

cancelPipelineRun

cancelPipelineRun(runId: string, options?: PipelineRunCancelPipelineRunOptionalParams): Promise<void>

- Defined in operationsInterfaces/pipelineRunOperations.ts:58
Cancel a pipeline run by its run ID.

Parameters
- runId: string
  
  The pipeline run identifier.
- Optional options: PipelineRunCancelPipelineRunOptionalParams
  
  The options parameters.
Returns Promise<void>

getPipelineRun

getPipelineRun(runId: string, options?: PipelineRunGetPipelineRunOptionalParams): Promise<PipelineRunGetPipelineRunResponse>

- Defined in operationsInterfaces/pipelineRunOperations.ts:36
Get a pipeline run by its run ID.

Parameters
- runId: string
  
  The pipeline run identifier.
- Optional options: PipelineRunGetPipelineRunOptionalParams
  
  The options parameters.
Returns Promise<PipelineRunGetPipelineRunResponse>

queryActivityRuns

queryActivityRuns(pipelineName: string, runId: string, filterParameters: RunFilterParameters, options?: PipelineRunQueryActivityRunsOptionalParams): Promise<PipelineRunQueryActivityRunsResponse>

- Defined in operationsInterfaces/pipelineRunOperations.ts:47
Query activity runs based on input filter conditions.

Parameters
- pipelineName: string
  
  The pipeline name.
- runId: string
  
  The pipeline run identifier.
- filterParameters: RunFilterParameters
  
  Parameters to filter the activity runs.
- Optional options: PipelineRunQueryActivityRunsOptionalParams
  
  The options parameters.
Returns Promise<PipelineRunQueryActivityRunsResponse>

queryPipelineRunsByWorkspace

queryPipelineRunsByWorkspace(filterParameters: RunFilterParameters, options?: PipelineRunQueryPipelineRunsByWorkspaceOptionalParams): Promise<PipelineRunQueryPipelineRunsByWorkspaceResponse>

- Defined in operationsInterfaces/pipelineRunOperations.ts:27
Query pipeline runs in the workspace based on input filter conditions.

Parameters
- filterParameters: RunFilterParameters
  
  Parameters to filter the pipeline run.
- Optional options: PipelineRunQueryPipelineRunsByWorkspaceOptionalParams
  
  The options parameters.
Returns Promise<PipelineRunQueryPipelineRunsByWorkspaceResponse>

Generated using TypeDoc