workflow_trigger_histories

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

Overview

Name	workflow_trigger_histories
Type	Resource
Id	azure.web.workflow_trigger_histories

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.
endTime	string (date-time)	Gets the end time.
error	object	Gets the error.
fired	boolean	The value indicating whether trigger was fired.
inputsLink	object	Gets the link to input parameters.
outputsLink	object	Gets the link to output parameters.
run	object	Gets the reference to workflow run.
scheduledTime	string (date-time)	The scheduled time.
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.
trackingId	string	Gets the tracking id.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
endTime	string (date-time)	Gets the end time.
error	object	Gets the error.
fired	boolean	The value indicating whether trigger was fired.
inputsLink	object	Gets the link to input parameters.
outputsLink	object	Gets the link to output parameters.
run	object	Gets the reference to workflow run.
scheduledTime	string (date-time)	The scheduled time.
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.
trackingId	string	Gets the tracking id.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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, trigger_name, history_name, subscription_id		Gets a workflow trigger history.
list	select	resource_group_name, name, workflow_name, trigger_name, subscription_id	$top, $filter	Gets a list of workflow trigger histories.
resubmit	exec	resource_group_name, name, workflow_name, trigger_name, history_name, subscription_id		Resubmits a workflow run based on the trigger history.

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
history_name	string	The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. Required.
name	string	Site name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
trigger_name	string	The workflow trigger name. Required.
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 trigger history.

SELECT
id,
name,
code,
correlation,
endTime,
error,
fired,
inputsLink,
outputsLink,
run,
scheduledTime,
startTime,
status,
systemData,
trackingId,
type
FROM azure.web.workflow_trigger_histories
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND trigger_name = '{{ trigger_name }}' -- required
AND history_name = '{{ history_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of workflow trigger histories.

SELECT
id,
name,
code,
correlation,
endTime,
error,
fired,
inputsLink,
outputsLink,
run,
scheduledTime,
startTime,
status,
systemData,
trackingId,
type
FROM azure.web.workflow_trigger_histories
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND workflow_name = '{{ workflow_name }}' -- required
AND trigger_name = '{{ trigger_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

resubmit

Resubmits a workflow run based on the trigger history.

EXEC azure.web.workflow_trigger_histories.resubmit 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@trigger_name='{{ trigger_name }}' --required, 
@history_name='{{ history_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;