lifecycle_workflows_workflows_versions

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

Overview

Name	lifecycle_workflows_workflows_versions
Type	Resource
Id	entra_id.identity_governance.lifecycle_workflows_workflows_versions

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
administrationScopeTargets	array	The administrative units in the scope of the workflow. Optional. Supports $expand.
category	string	(joiner, leaver, unknownFutureValue, mover) (title: lifecycleWorkflowCategory)
createdBy	object	The user who created the workflow. (title: entity)
createdDateTime	string (date-time)	When a workflow was created. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
description	string	A string that describes the purpose of the workflow.
displayName	string	A string to identify the workflow.
executionConditions	object	Defines when and for who the workflow will run. (title: workflowExecutionConditions)
isEnabled	boolean	Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true.
isSchedulingEnabled	boolean	If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Can't be true for a disabled workflow (where isEnabled is false).
lastModifiedBy	object	The unique identifier of the Microsoft Entra identity that last modified the workflow. (title: entity)
lastModifiedDateTime	string (date-time)	When the workflow was last modified. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
tasks	array	The tasks in the workflow.
versionNumber	number (int32)	The version of the workflow.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

list

Retrieved collection

Name	Datatype	Description
administrationScopeTargets	array	The administrative units in the scope of the workflow. Optional. Supports $expand.
category	string	(joiner, leaver, unknownFutureValue, mover) (title: lifecycleWorkflowCategory)
createdBy	object	The user who created the workflow. (title: entity)
createdDateTime	string (date-time)	When a workflow was created. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
description	string	A string that describes the purpose of the workflow.
displayName	string	A string to identify the workflow.
executionConditions	object	Defines when and for who the workflow will run. (title: workflowExecutionConditions)
isEnabled	boolean	Whether the workflow is enabled or disabled. If this setting is true, the workflow can be run on demand or on schedule when isSchedulingEnabled is true.
isSchedulingEnabled	boolean	If true, the Lifecycle Workflow engine executes the workflow based on the schedule defined by tenant settings. Can't be true for a disabled workflow (where isEnabled is false).
lastModifiedBy	object	The unique identifier of the Microsoft Entra identity that last modified the workflow. (title: entity)
lastModifiedDateTime	string (date-time)	When the workflow was last modified. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
tasks	array	The tasks in the workflow.
versionNumber	number (int32)	The version of the workflow.Supports $filter(lt, le, gt, ge, eq, ne) and $orderby.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workflow_id, workflow_version_version_number		Read the properties and relationships of a workflowVersion object.
list	select	workflow_id		Get a list of the workflowVersion objects and their properties.

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
workflow_id	string	The unique identifier of workflow
workflow_version_version_number	number (int32)	The unique identifier of workflowVersion

SELECT examples

get

Read the properties and relationships of a workflowVersion object.

SELECT
administrationScopeTargets,
category,
createdBy,
createdDateTime,
description,
displayName,
executionConditions,
isEnabled,
isSchedulingEnabled,
lastModifiedBy,
lastModifiedDateTime,
tasks,
versionNumber
FROM entra_id.identity_governance.lifecycle_workflows_workflows_versions
WHERE workflow_id = '{{ workflow_id }}' -- required
AND workflow_version_version_number = '{{ workflow_version_version_number }}' -- required
;

list

Get a list of the workflowVersion objects and their properties.

SELECT
administrationScopeTargets,
category,
createdBy,
createdDateTime,
description,
displayName,
executionConditions,
isEnabled,
isSchedulingEnabled,
lastModifiedBy,
lastModifiedDateTime,
tasks,
versionNumber
FROM entra_id.identity_governance.lifecycle_workflows_workflows_versions
WHERE workflow_id = '{{ workflow_id }}' -- required
;