lifecycle_workflows_workflow_templates_tasks
Creates, updates, deletes, gets or lists a lifecycle_workflows_workflow_templates_tasks resource.
Overview
| Name | lifecycle_workflows_workflow_templates_tasks |
| Type | Resource |
| Id | entra_id.identity_governance.lifecycle_workflows_workflow_templates_tasks |
Fields
The following fields are returned by SELECT queries:
- get
- list
Retrieved navigation property
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
arguments | array | Arguments included within the task. For guidance to configure this property, see Configure the arguments for built-in Lifecycle Workflow tasks. Required. |
category | string | (joiner, leaver, unknownFutureValue, mover) (title: lifecycleTaskCategory) |
continueOnError | boolean | A Boolean value that specifies whether, if this task fails, the workflow stops, and subsequent tasks aren't run. Optional. |
description | string | A string that describes the purpose of the task for administrative use. Optional. |
displayName | string | A unique string that identifies the task. Required.Supports $filter(eq, ne) and orderBy. |
executionSequence | number (int32) | An integer that states in what order the task runs in a workflow.Supports $orderby. |
isEnabled | boolean | A Boolean value that denotes whether the task is set to run or not. Optional.Supports $filter(eq, ne) and orderBy. |
taskDefinitionId | string | A unique template identifier for the task. For more information about the tasks that Lifecycle Workflows currently supports and their unique identifiers, see Configure the arguments for built-in Lifecycle Workflow tasks. Required.Supports $filter(eq, ne). |
taskProcessingResults | array | The result of processing the task. |
Retrieved collection
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
arguments | array | Arguments included within the task. For guidance to configure this property, see Configure the arguments for built-in Lifecycle Workflow tasks. Required. |
category | string | (joiner, leaver, unknownFutureValue, mover) (title: lifecycleTaskCategory) |
continueOnError | boolean | A Boolean value that specifies whether, if this task fails, the workflow stops, and subsequent tasks aren't run. Optional. |
description | string | A string that describes the purpose of the task for administrative use. Optional. |
displayName | string | A unique string that identifies the task. Required.Supports $filter(eq, ne) and orderBy. |
executionSequence | number (int32) | An integer that states in what order the task runs in a workflow.Supports $orderby. |
isEnabled | boolean | A Boolean value that denotes whether the task is set to run or not. Optional.Supports $filter(eq, ne) and orderBy. |
taskDefinitionId | string | A unique template identifier for the task. For more information about the tasks that Lifecycle Workflows currently supports and their unique identifiers, see Configure the arguments for built-in Lifecycle Workflow tasks. Required.Supports $filter(eq, ne). |
taskProcessingResults | array | The result of processing the task. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | workflow_template_id, task_id | Represents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default. | |
list | select | workflow_template_id | Represents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default. |
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 |
|---|---|---|
task_id | string | The unique identifier of task |
workflow_template_id | string | The unique identifier of workflowTemplate |
SELECT examples
- get
- list
Represents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default.
SELECT
id,
arguments,
category,
continueOnError,
description,
displayName,
executionSequence,
isEnabled,
taskDefinitionId,
taskProcessingResults
FROM entra_id.identity_governance.lifecycle_workflows_workflow_templates_tasks
WHERE workflow_template_id = '{{ workflow_template_id }}' -- required
AND task_id = '{{ task_id }}' -- required
;
Represents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default.
SELECT
id,
arguments,
category,
continueOnError,
description,
displayName,
executionSequence,
isEnabled,
taskDefinitionId,
taskProcessingResults
FROM entra_id.identity_governance.lifecycle_workflows_workflow_templates_tasks
WHERE workflow_template_id = '{{ workflow_template_id }}' -- required
;