workflow: cancelProcessing

Namespace: microsoft.graph.identityGovernance

Abbrechen einer oder mehrerer Workflowausführungen, die sich derzeit in queued oder inProgress status befinden. Derzeit ist das Abbrechen einer Ausführung pro Anforderung beschränkt.

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 mithilfe von 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. Lifecycle Workflows Administrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.

HTTP-Anforderung

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

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung der Parameter an.

In der folgenden Tabelle sind die Parameter aufgeführt, die für diese Aktion erforderlich sind.

Parameter Typ Beschreibung
Bereich microsoft.graph.identityGovernance.cancelScope Definiert den Bereich der workflowausführungen, die abgebrochen werden sollen. Derzeit wird nur cancelRunsScope unterstützt. Erforderlich.

cancelRunsScope-Eigenschaften

Bei Verwendung von cancelRunsScope ist die @odata.type -Eigenschaft im Anforderungstext erforderlich.

Eigenschaft Typ Beschreibung
@odata.type Zeichenfolge Muss #microsoft.graph.identityGovernance.cancelRunsScope sein. Erforderlich.
Läuft sammlung microsoft.graph.identityGovernance.run Der Workflow wird zum Abbrechen ausgeführt. 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: Erfolgreiches Abbrechen 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/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"
      }
    ]
  }
}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content
  • Last updated on