Freigeben über


Workflow: previewWorkflow

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.

Führen Sie einen Workflow im Vorschaumodus für ausgewählte Verzeichnisobjekte aus, ohne dass sich dies auf Produktionsbenutzer auswirkt. Diese Aktion löst die Workflowverarbeitung im Vorschaumodus aus, und Die Ergebnisse können mithilfe des Vorgangs UserProcessingResults auflisten mit $filter=workflowExecutionType eq 'previewMode'abgerufen werden.

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

In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra Rolle oder eine benutzerdefinierte Rolle mit einer unterstützten Rollenberechtigung zugewiesen werden. 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}/previewWorkflow

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
Themen directoryObject collection Eine Auflistung von Verzeichnisobjekten (in der Regel Benutzer), die in die Vorschauausführung eingeschlossen werden sollen. Maximal 10 Themen pro Anforderung. Erforderlich.

Antwort

Wenn die Aktion erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben.

Verwenden Sie zum Abrufen der Ergebnisse der Vorschauausführung den Vorgang auflisten userProcessingResults mit $filter=workflowExecutionType eq 'previewMode'. Die Ergebnisse sind möglicherweise nicht sofort verfügbar; Die Zeitliche Steuerung hängt von der Komplexität des Workflows ab. Die Ergebnisse können Benutzer aus vorherigen Vorschauausführungen für denselben Workflow enthalten.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

{
  "subjects": [
    {
      "@odata.type": "#microsoft.graph.user",
      "id": "b59552b8-fa7b-4f68-8496-0a529aace8c0"
    },
    {
      "@odata.type": "#microsoft.graph.user",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content