workflow_run_actions

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

Overview

Name	workflow_run_actions
Type	Resource
Id	azure.web.workflow_run_actions

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 correlation properties.
endTime	string (date-time)	Gets the end time.
error	object	Gets the error.
inputsLink	object	Gets the link to inputs.
outputsLink	object	Gets the link to outputs.
retryHistory	array	Gets the retry histories.
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.
trackedProperties	object	Gets the tracked properties.
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 correlation properties.
endTime	string (date-time)	Gets the end time.
error	object	Gets the error.
inputsLink	object	Gets the link to inputs.
outputsLink	object	Gets the link to outputs.
retryHistory	array	Gets the retry histories.
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.
trackedProperties	object	Gets the tracked properties.
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, run_name, action_name, subscription_id		Gets a workflow run action.
list	select	resource_group_name, name, workflow_name, run_name, subscription_id	$top, $filter	Gets a list of workflow run actions.
list_expression_traces	exec	resource_group_name, name, workflow_name, run_name, action_name, subscription_id		Lists a workflow run expression trace.

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
action_name	string	The workflow action name. Required.
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. 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 action.

SELECT
id,
name,
code,
correlation,
endTime,
error,
inputsLink,
outputsLink,
retryHistory,
startTime,
status,
systemData,
trackedProperties,
trackingId,
type
FROM azure.web.workflow_run_actions
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 action_name = '{{ action_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets a list of workflow run actions.

SELECT
id,
name,
code,
correlation,
endTime,
error,
inputsLink,
outputsLink,
retryHistory,
startTime,
status,
systemData,
trackedProperties,
trackingId,
type
FROM azure.web.workflow_run_actions
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
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

list_expression_traces

Lists a workflow run expression trace.

EXEC azure.web.workflow_run_actions.list_expression_traces 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@workflow_name='{{ workflow_name }}' --required, 
@run_name='{{ run_name }}' --required, 
@action_name='{{ action_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;