workflow_runs

Creates, updates, deletes, gets or lists a workflow_runs resource.

Overview

Name	workflow_runs
Type	Resource
Id	azure.web.workflow_runs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
code	string	Gets the code.
correlation	object	The run correlation.
correlationId	string	Gets the correlation id.
endTime	string (date-time)	Gets the end time.
error	object	Gets the error.
outputs	object	Gets the outputs.
response	object	Gets the response of the flow run.
startTime	string (date-time)	Gets the start time.
status	string	Gets the status. Known values are: "NotSpecified", "Paused", "Running", "Waiting", "Succeeded", "Skipped", "Suspended", "Cancelled", "Failed", "Faulted", "TimedOut", "Aborted", and "Ignored". (NotSpecified, Paused, Running, Waiting, Succeeded, Skipped, Suspended, Cancelled, Failed, Faulted, TimedOut, Aborted, Ignored)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
trigger	object	Gets the fired trigger.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
waitEndTime	string (date-time)	Gets the wait end time.
workflow	object	Gets the reference to workflow version.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
code	string	Gets the code.
correlation	object	The run correlation.
correlationId	string	Gets the correlation id.
endTime	string (date-time)	Gets the end time.
error	object	Gets the error.
outputs	object	Gets the outputs.
response	object	Gets the response of the flow run.
startTime	string (date-time)	Gets the start time.
status	string	Gets the status. Known values are: "NotSpecified", "Paused", "Running", "Waiting", "Succeeded", "Skipped", "Suspended", "Cancelled", "Failed", "Faulted", "TimedOut", "Aborted", and "Ignored". (NotSpecified, Paused, Running, Waiting, Succeeded, Skipped, Suspended, Cancelled, Failed, Faulted, TimedOut, Aborted, Ignored)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
trigger	object	Gets the fired trigger.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
waitEndTime	string (date-time)	Gets the wait end time.
workflow	object	Gets the reference to workflow version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, name, workflow_name, run_name, subscription_id		Gets a workflow run.
list	select	resource_group_name, name, workflow_name, subscription_id	$top, $filter	Gets a list of workflow runs.
cancel	exec	resource_group_name, name, workflow_name, run_name, subscription_id		Cancels a workflow run.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	Site name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
run_name	string	The workflow run name. Required.
subscription_id	string
workflow_name	string	The workflow name. Required.
$filter	string	The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId. Default value is None.
$top	integer	The number of items to be included in the result. Default value is None.

SELECT examples

get

Gets a workflow run.

SELECT
id,
name,
code,
correlation,
correlationId,
endTime,
error,
outputs,
response,
startTime,
status,
systemData,
trigger,
type,
waitEndTime,
workflow
FROM azure.web.workflow_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND run_name = '{{ run_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of workflow runs.

SELECT
id,
name,
code,
correlation,
correlationId,
endTime,
error,
outputs,
response,
startTime,
status,
systemData,
trigger,
type,
waitEndTime,
workflow
FROM azure.web.workflow_runs
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

cancel

Cancels a workflow run.

EXEC azure.web.workflow_runs.cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@run_name='{{ run_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;