lifecycle_workflows_task_definitions
Creates, updates, deletes, gets or lists a lifecycle_workflows_task_definitions resource.
Overview
| Name | lifecycle_workflows_task_definitions |
| Type | Resource |
| Id | entra_id.identity_governance.lifecycle_workflows_task_definitions |
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. |
category | string | (joiner, leaver, unknownFutureValue, mover) (title: lifecycleTaskCategory) |
continueOnError | boolean | Defines if the workflow will continue if the task has an error. |
description | string | The description of the taskDefinition. |
displayName | string | The display name of the taskDefinition.Supports $filter(eq, ne) and $orderby. |
parameters | array | The parameters that must be supplied when creating a workflow task object.Supports $filter(any). |
version | number (int32) | The version number of the taskDefinition. New records are pushed when we add support for new parameters.Supports $filter(ge, gt, le, lt, eq, ne) and $orderby. |
Retrieved collection
| Name | Datatype | Description |
|---|---|---|
id | string | The unique identifier for an entity. Read-only. |
category | string | (joiner, leaver, unknownFutureValue, mover) (title: lifecycleTaskCategory) |
continueOnError | boolean | Defines if the workflow will continue if the task has an error. |
description | string | The description of the taskDefinition. |
displayName | string | The display name of the taskDefinition.Supports $filter(eq, ne) and $orderby. |
parameters | array | The parameters that must be supplied when creating a workflow task object.Supports $filter(any). |
version | number (int32) | The version number of the taskDefinition. New records are pushed when we add support for new parameters.Supports $filter(ge, gt, le, lt, eq, ne) and $orderby. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | task_definition_id | Read the details of a built-in workflow task in Lifecycle Workflows. | |
list | select | Get a list of built-in tasks in Lifecycle Workflows. A task is represented by the taskDefinition object. |
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_definition_id | string | The unique identifier of taskDefinition |
SELECT examples
- get
- list
Read the details of a built-in workflow task in Lifecycle Workflows.
SELECT
id,
category,
continueOnError,
description,
displayName,
parameters,
version
FROM entra_id.identity_governance.lifecycle_workflows_task_definitions
WHERE task_definition_id = '{{ task_definition_id }}' -- required
;
Get a list of built-in tasks in Lifecycle Workflows. A task is represented by the taskDefinition object.
SELECT
id,
category,
continueOnError,
description,
displayName,
parameters,
version
FROM entra_id.identity_governance.lifecycle_workflows_task_definitions
;