Namespace: microsoft.graph.identityGovernance
Wichtig
Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Brechen Sie eine oder mehrere Workflowausführungen ab, die sich aktuell im queuedinProgress oder Status befinden. Derzeit auf den Abbruch einer Ausführung pro Anforderung beschränkt.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
| Weltweiter Service |
US Government L4 |
US Government L5 (DOD) |
China, betrieben von 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Berechtigungen
Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
| Berechtigungstyp |
Berechtigungen mit den geringsten Berechtigungen |
Berechtigungen mit höheren Berechtigungen |
| Delegiert (Geschäfts-, Schul- oder Unikonto) |
LifecycleWorkflows-Workflow.ReadWrite.All |
LifecycleWorkflows.ReadWrite.All |
| Delegiert (persönliches Microsoft-Konto) |
Nicht unterstützt |
Nicht unterstützt |
| Application |
LifecycleWorkflows-Workflow.ReadWrite.All |
LifecycleWorkflows.ReadWrite.All |
Wichtig
Für den delegierten Zugriff mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle zugewiesen werden, die die für diesen Vorgang erforderlichen Berechtigungen gewährt.
Lebenszyklusworkflows Die Rolle "Administrator " mit den geringsten Berechtigungen wird für diesen Vorgang unterstützt.
HTTP-Anforderung
POST /identityGovernance/lifecycleWorkflows/workflows/{workflow-id}/cancelProcessing
Anforderungstext
Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.
Die folgende Tabelle zeigt die Parameter, die für diese Aktion erforderlich sind.
cancelRunsScope-Eigenschaften
Bei der Verwendung von cancelRunsScope ist die @odata.type Eigenschaft im Anforderungstext erforderlich.
| Eigenschaft |
Typ |
Beschreibung |
| @odata.type |
Zeichenfolge |
Muss #microsoft.graph.identityGovernance.cancelRunsScope sein. Erforderlich. |
| Ausführungen |
microsoft.graph.identityGovernance.run-Sammlung |
Der Workflow wird ausgeführt, um abzubrechen. Derzeit auf eine Ausführung pro Anforderung beschränkt. Erforderlich. |
Antwort
Wenn die Aktion erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben.
Beispiele
Beispiel 1: Erfolgreiche Stornierung einer Workflowausführung
Das folgende Beispiel zeigt eine Anforderung, die eine einzelne Workflowausführung erfolgreich abbricht.
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
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();
Import-Module Microsoft.Graph.Beta.Identity.Governance
$params = @{
scope = @{
"@odata.type" = "#microsoft.graph.identityGovernance.cancelRunsScope"
runs = @(
@{
id = "8cdf25a8-c9d2-423e-a03d-3f39f03c3e97"
}
)
}
}
Stop-MgBetaIdentityGovernanceLifecycleWorkflowProcessing -WorkflowId $workflowId -BodyParameter $params
# 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)
Antwort
Das folgende Beispiel zeigt die Antwort.
HTTP/1.1 204 No Content