Skip to main content

workflow_tasks

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

Overview

Nameworkflow_tasks
TypeResource
Idazure.purview_workflow.workflow_tasks

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:

NameAccessible byRequired ParamsOptional ParamsDescription
list_rawexecendpointviewMode, workflowIds, timeWindow, maxpagesize, orderby, taskTypes, taskStatuses, requestors, assignees, workflowNameKeywordGet all workflow tasks.

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.

NameDatatypeDescription
endpointstringThe service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
assigneesarrayAssignees' ids to filter. Default value is None.
maxpagesizeinteger
orderbystringThe 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.
requestorsarrayRequestors' ids to filter. Default value is None.
taskStatusesarrayFilter workflow tasks by status. Default value is None.
taskTypesarrayFilter items by workflow task type. Default value is None.
timeWindowstringTime window of filtering items. Known values are: "1d", "7d", "30d", and "90d". Default value is None.
viewModestringTo filter user's sent, received or history workflow tasks. Default value is None.
workflowIdsarrayFilter items by workflow id list. Default value is None.
workflowNameKeywordstringThe key word which could used to filter workflow item with related workflow. Default value is None.

Lifecycle Methods

Get all workflow tasks.

EXEC azure.purview_workflow.workflow_tasks.list_raw 
@endpoint='{{ endpoint }}' --required,
@viewMode='{{ viewMode }}',
@workflowIds='{{ workflowIds }}',
@timeWindow='{{ timeWindow }}',
@maxpagesize='{{ maxpagesize }}',
@orderby='{{ orderby }}',
@taskTypes='{{ taskTypes }}',
@taskStatuses='{{ taskStatuses }}',
@requestors='{{ requestors }}',
@assignees='{{ assignees }}',
@workflowNameKeyword='{{ workflowNameKeyword }}'
;