workflow_runs

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

Overview

Name	workflow_runs
Type	Resource
Id	azure.logic_apps.workflow_runs

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the workflow run name.
properties	object	The workflow run properties.
type	string	Gets the workflow run type.

list

Name	Datatype	Description
id	string	The resource id.
name	string	Gets the workflow run name.
properties	object	The workflow run properties.
type	string	Gets the workflow run type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workflowName, runName	api-version	Gets a workflow run.
list	select	subscriptionId, resourceGroupName, workflowName	api-version, $top, $filter	Gets a list of workflow runs.
cancel	exec	subscriptionId, resourceGroupName, workflowName, runName	api-version	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
resourceGroupName	string	The resource group name.
runName	string	The workflow run name.
subscriptionId	string	The subscription id.
workflowName	string	The workflow name.
$filter	string	The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.
$top	integer (int32)	The number of items to be included in the result.
api-version	string	The API version.

SELECT examples

get

Gets a workflow run.

SELECT
id,
name,
properties,
type
FROM azure.logic_apps.workflow_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workflowName = '{{ workflowName }}' -- required
AND runName = '{{ runName }}' -- required
AND api-version = '{{ api-version }}'
;

list

Gets a list of workflow runs.

SELECT
id,
name,
properties,
type
FROM azure.logic_apps.workflow_runs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workflowName = '{{ workflowName }}' -- required
AND api-version = '{{ api-version }}'
AND $top = '{{ $top }}'
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

cancel

Cancels a workflow run.

EXEC azure.logic_apps.workflow_runs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@runName='{{ runName }}' --required, 
@api-version='{{ api-version }}'
;