工作流资源类型
命名空间:microsoft.graph.identityGovernance
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示使用生命周期工作流创建的工作流。 工作流在由执行条件触发时,使用任务自动执行生命周期管理过程的各个部分。 这些任务可以是内置任务,也可以是使用与 Azure 逻辑应用集成的自定义任务扩展调用自定义任务。
一个租户中最多可以创建 100 个工作流。
继承自 workflowBase。
方法
方法 | 返回类型 | 说明 |
---|---|---|
列出工作流 | microsoft.graph.identityGovernance.workflow 集合 | 获取 工作流 对象及其属性的列表。 |
创建工作流 | microsoft.graph.identityGovernance.workflow | 创建新的 工作流 对象。 |
获取工作流 | microsoft.graph.identityGovernance.workflow | 读取 工作流 对象的属性和关系。 |
更新工作流 | microsoft.graph.identityGovernance.workflow | 更新 工作流 对象的属性。 |
删除工作流 | 无 | 删除 工作流 对象。 |
列出范围内的用户 | microsoft.graph.user 集合 | 获取处于 工作流 对象执行条件范围内的用户列表。 |
获取已删除的工作流 | microsoft.graph.identityGovernance.workflow | 获取已删除的 工作流。 |
永久删除工作流 | 无 | 永久删除 工作流 对象。 |
列出已删除的工作流 | microsoft.graph.identityGovernance.workflow 集合 | 获取已删除的 工作流 对象及其属性的列表。 |
激活 | 无 | 按需运行工作流。 |
创建 workflowVersion | microsoft.graph.identityGovernance.workflowVersion | 创建新的 workflowVersion 对象。 |
恢复 | microsoft.graph.identityGovernance.workflow | 还原已删除的工作流。 |
列出运行 | microsoft.graph.identityGovernance.run 集合 | 获取工作流的 运行 列表。 |
获取任务 | microsoft.graph.identityGovernance.task 集合 | 获取工作流中 任务 的属性。 |
List tasks | microsoft.graph.identityGovernance.task 集合 | 获取工作流中的 任务 对象列表。 |
列出版本 | microsoft.graph.identityGovernance.workflowVersion 集合 | 获取 工作流的工作流版本 列表。 |
属性
属性 | 类型 | 说明 |
---|---|---|
“类别” | microsoft.graph.identityGovernance.lifecycleWorkflowCategory | 使用此模板创建的工作流支持的 HR 函数类别。 一个工作流只能属于一个类别。 可能的值为: joiner 、 leaver 、 mover 、unknownFutureValue 。 继承自 workflowBase。 必填。支持 $filter (eq 、ne ) 和 $orderby |
createdDateTime | DateTimeOffset | workflow 创建 时。 继承自 workflowBase。支持 $filter (lt 、le 、、ge gt 、 ne eq ) 和 $orderby 。 |
deletedDateTime | DateTimeOffset | 删除工作流时。 支持 $filter (lt 、le 、、ge gt 、 ne eq ) 和 $orderby 。 |
说明 | String | 的说明 workflow 。 继承自 workflowBase。 可选。 |
displayName | String | 的 workflow 显示名称。 继承自 workflowBase。 必填。支持 $filter (eq 、 ne ) 和 orderby 。 |
executionConditions | microsoft.graph.identityGovernance.workflowExecutionConditions | 描述何时执行工作流的条件以及用于标识范围内主题集的条件。 继承自 workflowBase。 必需。 |
id | String | 用于单独寻址特定工作流的标识符。 支持 $filter (eq 、 ne ) 和 $orderby 。 |
isEnabled | Boolean | 是启用还是禁用工作流。 如果此设置为 true ,则当 IsSchedulingEnabled 为 true 时,可以按需或按计划运行工作流。 继承自 workflowBase。 可选。 默认为 true 。支持 $filter (eq 、 ne ) 和 orderBy 。 |
isSchedulingEnabled | 布尔值 | 如果 true 为 ,则生命周期工作流引擎根据 租户设置定义的计划执行工作流。 true 对于) isEnabledfalse 的已禁用工作流 (,不能为 。 继承自 workflowBase。 可选。 默认为 false 。支持 $filter (eq 、 ne ) 和 orderBy 。 |
lastModifiedDateTime | DateTimeOffset | 上次修改 的日期时间 workflow 。 继承自 workflowBase。支持 $filter (lt 、le 、、ge gt 、 ne eq ) 和 $orderby 。 |
nextScheduleRunDateTime | DateTimeOffset | 如果有任何用户与执行条件匹配,则根据计划间隔预计下一次运行 的日期时间 workflow 。 支持 $filter (lt 、gt ) 和 $orderby 。 |
version | Int32 | 工作流的当前版本号。 首次创建工作流时,值为 1。 支持 $filter (lt 、le 、、ge gt 、 ne eq ) 和 $orderby 。 |
关系
关系 | 类型 | 说明 |
---|---|---|
createdBy | user | 创建工作流对象的Microsoft Entra用户的唯一标识符。 继承自 workflowBase。 支持 $filter (eq 、 ne ) 和 $expand 。 |
executionScope | microsoft.graph.user 集合 | 上次修改工作流对象的Microsoft Entra标识的唯一标识符。 |
lastModifiedBy | 用户 | 上次修改 工作流 对象的用户。 继承自 workflowBase。 支持 $filter (eq 、 ne ) 和 $expand 。 |
运行 | microsoft.graph.identityGovernance.run 集合 | 工作流运行。 |
taskReports | microsoft.graph.identityGovernance.taskReport 集合 | 表示 工作流 对象中任务的任务执行数据的聚合。 |
tasks | microsoft.graph.identityGovernance.task 集合 | 表示要执行的配置任务及其在 工作流 对象中的执行顺序。 继承自 workflowBase。 必填。 |
userProcessingResults | microsoft.graph.identityGovernance.userProcessingResult 集合 | 每用户工作流执行结果。 |
版本 | microsoft.graph.identityGovernance.workflowVersion 集合 | 可用的工作流版本。 |
JSON 表示形式
下面是资源的 JSON 表示形式。
{
"@odata.type": "#microsoft.graph.identityGovernance.workflow",
"category": "String",
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"executionConditions": {
"@odata.type": "microsoft.graph.identityGovernance.workflowExecutionConditions"
},
"lastModifiedDateTime": "String (timestamp)",
"deletedDateTime": "String (timestamp)",
"id": "String (identifier)",
"isEnabled": "Boolean",
"isSchedulingEnabled": "Boolean",
"nextScheduleRunDateTime": "String (timestamp)",
"version": "Integer"
}
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈