Пространство имен: microsoft.graph.identityGovernance
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Отмена одного или нескольких запусков рабочих процессов , которые в настоящее время находятся в queued состоянии или inProgress . В настоящее время ограничивается отменой одного запуска на запрос.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба |
Правительство США L4 |
Правительство США L5 (DOD) |
Китай управляется 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения |
Разрешения с наименьшими привилегиями |
Более высокие привилегированные разрешения |
| Делегированные (рабочая или учебная учетная запись) |
LifecycleWorkflows-Workflow.ReadWrite.All |
LifecycleWorkflows.ReadWrite.All |
| Делегированные (личная учетная запись Майкрософт) |
Не поддерживается. |
Не поддерживается. |
| Приложение |
LifecycleWorkflows-Workflow.ReadWrite.All |
LifecycleWorkflows.ReadWrite.All |
Важно!
Для делегированного доступа с использованием рабочих или учебных учетных записей пользователю, выполнившего вход, необходимо назначить поддерживаемую роль Microsoft Entra или пользовательскую роль, которая предоставляет разрешения, необходимые для этой операции.
Администратор рабочих процессов жизненного цикла — это наименее привилегированная роль, поддерживаемая для этой операции.
HTTP-запрос
POST /identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/cancelProcessing
Текст запроса
В тексте запроса укажите представление параметров в формате JSON.
В следующей таблице показаны параметры, необходимые для этого действия.
Свойства cancelRunsScope
При использовании cancelRunsScope@odata.type свойство является обязательным в тексте запроса.
| Свойство |
Тип |
Описание |
| @odata.type |
String |
Должно быть задано значение #microsoft.graph.identityGovernance.cancelRunsScope. Обязательно. |
| Работает |
коллекция microsoft.graph.identityGovernance.run |
Рабочий процесс выполняется для отмены. В настоящее время ограничено одним выполнением на запрос. Обязательно. |
Отклик
В случае успешного выполнения это действие возвращает код отклика 204 No Content.
Примеры
Пример 1. Успешное выполнение рабочего процесса
В следующем примере показан запрос, который успешно отменяет один запуск рабочего процесса.
Запрос
Ниже показан пример запроса.
POST https://graph.microsoft.com/beta/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"
}
]
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.IdentityGovernance.LifecycleWorkflows.Workflows.Item.MicrosoftGraphIdentityGovernanceCancelProcessing;
using Microsoft.Graph.Beta.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);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphidentitygovernance "github.com/microsoftgraph/msgraph-beta-sdk-go/identitygovernance"
graphmodelsidentitygovernance "github.com/microsoftgraph/msgraph-beta-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)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancecancelprocessing.CancelProcessingPostRequestBody cancelProcessingPostRequestBody = new com.microsoft.graph.beta.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancecancelprocessing.CancelProcessingPostRequestBody();
com.microsoft.graph.beta.models.identitygovernance.CancelRunsScope scope = new com.microsoft.graph.beta.models.identitygovernance.CancelRunsScope();
scope.setOdataType("#microsoft.graph.identityGovernance.cancelRunsScope");
LinkedList<com.microsoft.graph.beta.models.identitygovernance.Run> runs = new LinkedList<com.microsoft.graph.beta.models.identitygovernance.Run>();
com.microsoft.graph.beta.models.identitygovernance.Run run = new com.microsoft.graph.beta.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);
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')
.version('beta')
.post(cancelProcessing);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\IdentityGovernance\LifecycleWorkflows\Workflows\Item\MicrosoftGraphIdentityGovernanceCancelProcessing\CancelProcessingPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\IdentityGovernance\CancelRunsScope;
use Microsoft\Graph\Beta\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();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.identitygovernance.lifecycleworkflows.workflows.item.microsoft_graph_identity_governance_cancel_processing.cancel_processing_post_request_body import CancelProcessingPostRequestBody
from msgraph_beta.generated.models.identity_governance.cancel_runs_scope import CancelRunsScope
from msgraph_beta.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)
Отклик
Ниже приводится пример отклика.
HTTP/1.1 204 No Content