工作流：cancelProcessing

命名空间：microsoft.graph.identityGovernance

取消当前处于 或 inProgress 状态的queued一个或多个工作流运行。 当前限制为每个请求取消一次运行。

此 API 可用于以下国家级云部署。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	LifecycleWorkflows-Workflow.ReadWrite.All	LifecycleWorkflows.ReadWrite.All
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	LifecycleWorkflows-Workflow.ReadWrite.All	LifecycleWorkflows.ReadWrite.All

重要

对于使用工作或学校帐户的委派访问，必须为登录用户分配受支持的Microsoft Entra角色或授予此操作所需权限的自定义角色。 生命周期工作流管理员 是此操作支持的最低特权角色。

HTTP 请求

POST /identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/cancelProcessing

请求标头

名称	说明
Authorization	持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type	application/json. 必需。

请求正文

在请求正文中，提供参数的 JSON 表示形式。

下表显示了此操作所需的参数。

参数	类型	说明
范围	microsoft.graph.identityGovernance.cancelScope	定义要取消的工作流运行的范围。 目前仅支持 cancelRunsScope 。 必填。

cancelRunsScope 属性

使用 cancelRunsScope 时， @odata.type 请求正文中需要 属性。

属性	类型	说明
@odata.type	String	必须是 #microsoft.graph.identityGovernance.cancelRunsScope。 必填。
运行	microsoft.graph.identityGovernance.run 集合	工作流运行以取消。 当前限制为每个请求运行一次。 必填。

响应

如果成功，此操作返回 204 No Content 响应代码。

示例

示例 1：成功取消工作流运行

以下示例演示成功取消单个工作流运行的请求。

请求

以下示例显示了一个请求。

HTTP

POST https://graph.microsoft.com/v1.0/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/cancelProcessing
Content-Type: application/json

{
  "scope": {
    "@odata.type": "#microsoft.graph.identityGovernance.cancelRunsScope",
    "runs": [
      {
        "id": "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97"
      }
    ]
  }
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.IdentityGovernance.LifecycleWorkflows.Workflows.Item.MicrosoftGraphIdentityGovernanceCancelProcessing;
using Microsoft.Graph.Models.IdentityGovernance;

var requestBody = new CancelProcessingPostRequestBody
{
	Scope = new CancelRunsScope
	{
		OdataType = "#microsoft.graph.identityGovernance.cancelRunsScope",
		Runs = new List<Run>
		{
			new Run
			{
				Id = "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97",
			},
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.IdentityGovernance.LifecycleWorkflows.Workflows["{workflow-id}"].MicrosoftGraphIdentityGovernanceCancelProcessing.PostAsync(requestBody);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

转到

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphidentitygovernance "github.com/microsoftgraph/msgraph-sdk-go/identitygovernance"
	  graphmodelsidentitygovernance "github.com/microsoftgraph/msgraph-sdk-go/models/identitygovernance"
	  //other-imports
)

requestBody := graphidentitygovernance.NewCancelProcessingPostRequestBody()
scope := graphmodelsidentitygovernance.NewCancelRunsScope()


run := graphmodelsidentitygovernance.NewRun()
id := "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97"
run.SetId(&id) 

runs := []graphmodelsidentitygovernance.Runable {
	run,
}
scope.SetRuns(runs)
requestBody.SetScope(scope)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.IdentityGovernance().LifecycleWorkflows().Workflows().ByWorkflowId("workflow-id").MicrosoftGraphIdentityGovernanceCancelProcessing().Post(context.Background(), requestBody, nil)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancecancelprocessing.CancelProcessingPostRequestBody cancelProcessingPostRequestBody = new com.microsoft.graph.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancecancelprocessing.CancelProcessingPostRequestBody();
com.microsoft.graph.models.identitygovernance.CancelRunsScope scope = new com.microsoft.graph.models.identitygovernance.CancelRunsScope();
scope.setOdataType("#microsoft.graph.identityGovernance.cancelRunsScope");
LinkedList<com.microsoft.graph.models.identitygovernance.Run> runs = new LinkedList<com.microsoft.graph.models.identitygovernance.Run>();
com.microsoft.graph.models.identitygovernance.Run run = new com.microsoft.graph.models.identitygovernance.Run();
run.setId("8cdf25a8-c9d2-423e-a03d-3f39f03c3e97");
runs.add(run);
scope.setRuns(runs);
cancelProcessingPostRequestBody.setScope(scope);
graphClient.identityGovernance().lifecycleWorkflows().workflows().byWorkflowId("{workflow-id}").microsoftGraphIdentityGovernanceCancelProcessing().post(cancelProcessingPostRequestBody);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const cancelProcessing = {
  scope: {
    '@odata.type': '#microsoft.graph.identityGovernance.cancelRunsScope',
    runs: [
      {
        id: '8cdf25a8-c9d2-423e-a03d-3f39f03c3e97'
      }
    ]
  }
};

await client.api('/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/cancelProcessing')
	.post(cancelProcessing);

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\IdentityGovernance\LifecycleWorkflows\Workflows\Item\MicrosoftGraphIdentityGovernanceCancelProcessing\CancelProcessingPostRequestBody;
use Microsoft\Graph\Generated\Models\IdentityGovernance\CancelRunsScope;
use Microsoft\Graph\Generated\Models\IdentityGovernance\Run;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new CancelProcessingPostRequestBody();
$scope = new CancelRunsScope();
$scope->setOdataType('#microsoft.graph.identityGovernance.cancelRunsScope');
$runsRun1 = new Run();
$runsRun1->setId('8cdf25a8-c9d2-423e-a03d-3f39f03c3e97');
$runsArray []= $runsRun1;
$scope->setRuns($runsArray);

$requestBody->setScope($scope);

$graphServiceClient->identityGovernance()->lifecycleWorkflows()->workflows()->byWorkflowId('workflow-id')->microsoftGraphIdentityGovernanceCancelProcessing()->post($requestBody)->wait();

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.identitygovernance.lifecycleworkflows.workflows.item.microsoft_graph_identity_governance_cancel_processing.cancel_processing_post_request_body import CancelProcessingPostRequestBody
from msgraph.generated.models.identity_governance.cancel_runs_scope import CancelRunsScope
from msgraph.generated.models.identity_governance.run import Run
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = CancelProcessingPostRequestBody(
	scope = CancelRunsScope(
		odata_type = "#microsoft.graph.identityGovernance.cancelRunsScope",
		runs = [
			Run(
				id = "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97",
			),
		],
	),
)

await graph_client.identity_governance.lifecycle_workflows.workflows.by_workflow_id('workflow-id').microsoft_graph_identity_governance_cancel_processing.post(request_body)

有关如何将 SDK 添加到项目并创建 authProvider 实例的详细信息，请参阅 SDK 文档。

---

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content