TriggerRuns interface
Interface representing a TriggerRuns.
Methods
| cancel(string, string, string, string, Trigger |
Cancel a single trigger instance by runId. |
| query |
Query trigger runs. |
| rerun(string, string, string, string, Trigger |
Rerun single trigger instance by runId. |
Method Details
cancel(string, string, string, string, TriggerRunsCancelOptionalParams)
Cancel a single trigger instance by runId.
function cancel(resourceGroupName: string, factoryName: string, triggerName: string, runId: string, options?: TriggerRunsCancelOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- triggerName
-
string
The trigger name.
- runId
-
string
The pipeline run identifier.
- options
- TriggerRunsCancelOptionalParams
The options parameters.
Returns
Promise<void>
queryByFactory(string, string, RunFilterParameters, TriggerRunsQueryByFactoryOptionalParams)
Query trigger runs.
function queryByFactory(resourceGroupName: string, factoryName: string, filterParameters: RunFilterParameters, options?: TriggerRunsQueryByFactoryOptionalParams): Promise<TriggerRunsQueryResponse>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<TriggerRunsQueryResponse>
rerun(string, string, string, string, TriggerRunsRerunOptionalParams)
Rerun single trigger instance by runId.
function rerun(resourceGroupName: string, factoryName: string, triggerName: string, runId: string, options?: TriggerRunsRerunOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- factoryName
-
string
The factory name.
- triggerName
-
string
The trigger name.
- runId
-
string
The pipeline run identifier.
- options
- TriggerRunsRerunOptionalParams
The options parameters.
Returns
Promise<void>