WorkflowRuns interface
Interface representing a WorkflowRuns.
Methods
| cancel(string, string, string, Workflow |
Cancels a workflow run. |
| get(string, string, string, Workflow |
Gets a workflow run. |
| list(string, string, Workflow |
Gets a list of workflow runs. |
Method Details
cancel(string, string, string, WorkflowRunsCancelOptionalParams)
Cancels a workflow run.
function cancel(resourceGroupName: string, workflowName: string, runName: string, options?: WorkflowRunsCancelOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- runName
-
string
The workflow run name.
- options
- WorkflowRunsCancelOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, WorkflowRunsGetOptionalParams)
Gets a workflow run.
function get(resourceGroupName: string, workflowName: string, runName: string, options?: WorkflowRunsGetOptionalParams): Promise<WorkflowRun>Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- runName
-
string
The workflow run name.
- options
- WorkflowRunsGetOptionalParams
The options parameters.
Returns
Promise<WorkflowRun>
list(string, string, WorkflowRunsListOptionalParams)
Gets a list of workflow runs.
function list(resourceGroupName: string, workflowName: string, options?: WorkflowRunsListOptionalParams): PagedAsyncIterableIterator<WorkflowRun, WorkflowRun[], PageSettings>Parameters
- resourceGroupName
-
string
The resource group name.
- workflowName
-
string
The workflow name.
- options
- WorkflowRunsListOptionalParams
The options parameters.