Package version:

Interface TriggerRuns

Interface representing a TriggerRuns.

interface TriggerRuns {
    cancel(resourceGroupName: string, factoryName: string, triggerName: string, runId: string, options?: TriggerRunsCancelOptionalParams): Promise<void>;
    queryByFactory(resourceGroupName: string, factoryName: string, filterParameters: RunFilterParameters, options?: TriggerRunsQueryByFactoryOptionalParams): Promise<TriggerRunsQueryResponse>;
    rerun(resourceGroupName: string, factoryName: string, triggerName: string, runId: string, options?: TriggerRunsRerunOptionalParams): Promise<void>;
}

Methods

cancel(resourceGroupName, factoryName, triggerName, runId, options?): Promise<void>
Cancel a single trigger instance by runId.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- triggerName: string
  The trigger name.
- runId: string
  The pipeline run identifier.
- Optionaloptions: TriggerRunsCancelOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/triggerRuns.ts:42

queryByFactory(resourceGroupName, factoryName, filterParameters, options?): Promise<TriggerRunsQueryResponse>
Query trigger runs.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- filterParameters: RunFilterParameters
  Parameters to filter the pipeline run.
- Optionaloptions: TriggerRunsQueryByFactoryOptionalParams
  The options parameters.
Returns Promise<TriggerRunsQueryResponse>
- Defined in operationsInterfaces/triggerRuns.ts:56

rerun(resourceGroupName, factoryName, triggerName, runId, options?): Promise<void>
Rerun single trigger instance by runId.
Parameters
- resourceGroupName: string
  The resource group name.
- factoryName: string
  The factory name.
- triggerName: string
  The trigger name.
- runId: string
  The pipeline run identifier.
- Optionaloptions: TriggerRunsRerunOptionalParams
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/triggerRuns.ts:27