workflow_runs

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

Overview

Name	workflow_runs
Type	Resource
Id	azure.app_service.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, name, workflowName, runName		Gets a workflow run.
list	select	subscriptionId, resourceGroupName, name, workflowName	$top, $filter	Gets a list of workflow runs.
cancel	exec	subscriptionId, resourceGroupName, name, workflowName, runName		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.
resourceGroupName	string	Name of the resource group to which the resource belongs.
runName	string	The workflow run name.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
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.

SELECT examples

get

Gets a workflow run.

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

list

Gets a list of workflow runs.

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

Lifecycle Methods

cancel

Cancels a workflow run.

EXEC azure.app_service.workflow_runs.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@workflowName='{{ workflowName }}' --required, 
@runName='{{ runName }}' --required
;