workflow_runs

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

Overview

Name	workflow_runs
Type	Resource
Id	azure.purview_workflow.workflow_runs

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_raw	exec	endpoint	viewMode, timeWindow, orderby, runStatuses, workflowIds, requestors, maxpagesize	List workflow runs.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
maxpagesize	integer
orderby	string	The key word which used to sort the results. Known values are: "status desc", "status asc", "requestor desc", "requestor asc", "startTime desc", "startTime asc", "createdTime desc", and "createdTime asc". Default value is None.
requestors	array	Requestors' ids to filter. Default value is None.
runStatuses	array	Filter workflow runs by workflow run status. Default value is None.
timeWindow	string	Time window of filtering items. Known values are: "1d", "7d", "30d", and "90d". Default value is None.
viewMode	string	To filter user's workflow runs or view as admin. Default value is None.
workflowIds	array	Filter items by workflow id list. Default value is None.

Lifecycle Methods

list_raw

List workflow runs.

EXEC azure.purview_workflow.workflow_runs.list_raw 
@endpoint='{{ endpoint }}' --required, 
@viewMode='{{ viewMode }}', 
@timeWindow='{{ timeWindow }}', 
@orderby='{{ orderby }}', 
@runStatuses='{{ runStatuses }}', 
@workflowIds='{{ workflowIds }}', 
@requestors='{{ requestors }}', 
@maxpagesize='{{ maxpagesize }}'
;