PipelineRuns interface
Interface representing a PipelineRuns.
Methods
| cancel(string, string, string, Pipeline |
Cancel a pipeline run by its run ID. |
| get(string, string, string, Pipeline |
Get a pipeline run by its run ID. |
| query |
Query pipeline runs in the factory based on input filter conditions. |
Method Details
cancel(string, string, string, PipelineRunsCancelOptionalParams)
Cancel a pipeline run by its run ID.
function cancel(resourceGroupName: string, factoryName: string, runId: string, options?: PipelineRunsCancelOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- runId
-
string
The pipeline run identifier.
- options
- PipelineRunsCancelOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, PipelineRunsGetOptionalParams)
Get a pipeline run by its run ID.
function get(resourceGroupName: string, factoryName: string, runId: string, options?: PipelineRunsGetOptionalParams): Promise<PipelineRun>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- runId
-
string
The pipeline run identifier.
- options
- PipelineRunsGetOptionalParams
The options parameters.
Returns
Promise<PipelineRun>
queryByFactory(string, string, RunFilterParameters, PipelineRunsQueryByFactoryOptionalParams)
Query pipeline runs in the factory based on input filter conditions.
function queryByFactory(resourceGroupName: string, factoryName: string, filterParameters: RunFilterParameters, options?: PipelineRunsQueryByFactoryOptionalParams): Promise<PipelineRunsQueryResponse>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- filterParameters
- RunFilterParameters
Parameters to filter the pipeline run.
The options parameters.
Returns
Promise<PipelineRunsQueryResponse>