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
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}/previewWorkflow
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"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.IdentityGovernance.LifecycleWorkflows.Workflows.Item.MicrosoftGraphIdentityGovernancePreviewWorkflow;
using Microsoft.Graph.Beta.Models;
var requestBody = new PreviewWorkflowPostRequestBody
{
Subjects = new List<DirectoryObject>
{
new User
{
OdataType = "#microsoft.graph.user",
Id = "b59552b8-fa7b-4f68-8496-0a529aace8c0",
},
new User
{
OdataType = "#microsoft.graph.user",
Id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
},
},
};
// 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}"].MicrosoftGraphIdentityGovernancePreviewWorkflow.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"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphidentitygovernance.NewPreviewWorkflowPostRequestBody()
directoryObject := graphmodels.NewUser()
id := "b59552b8-fa7b-4f68-8496-0a529aace8c0"
directoryObject.SetId(&id)
directoryObject1 := graphmodels.NewUser()
id := "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
directoryObject1.SetId(&id)
subjects := []graphmodels.DirectoryObjectable {
directoryObject,
directoryObject1,
}
requestBody.SetSubjects(subjects)
// 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").MicrosoftGraphIdentityGovernancePreviewWorkflow().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.microsoftgraphidentitygovernancepreviewworkflow.PreviewWorkflowPostRequestBody previewWorkflowPostRequestBody = new com.microsoft.graph.beta.identitygovernance.lifecycleworkflows.workflows.item.microsoftgraphidentitygovernancepreviewworkflow.PreviewWorkflowPostRequestBody();
LinkedList<DirectoryObject> subjects = new LinkedList<DirectoryObject>();
User directoryObject = new User();
directoryObject.setOdataType("#microsoft.graph.user");
directoryObject.setId("b59552b8-fa7b-4f68-8496-0a529aace8c0");
subjects.add(directoryObject);
User directoryObject1 = new User();
directoryObject1.setOdataType("#microsoft.graph.user");
directoryObject1.setId("a1b2c3d4-e5f6-7890-abcd-ef1234567890");
subjects.add(directoryObject1);
previewWorkflowPostRequestBody.setSubjects(subjects);
graphClient.identityGovernance().lifecycleWorkflows().workflows().byWorkflowId("{workflow-id}").microsoftGraphIdentityGovernancePreviewWorkflow().post(previewWorkflowPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const previewWorkflow = {
subjects: [
{
'@odata.type': '#microsoft.graph.user',
id: 'b59552b8-fa7b-4f68-8496-0a529aace8c0'
},
{
'@odata.type': '#microsoft.graph.user',
id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'
}
]
};
await client.api('/identityGovernance/lifecycleWorkflows/workflows/14879e66-9ea9-48d0-804d-8fea672d0341/previewWorkflow')
.version('beta')
.post(previewWorkflow);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\IdentityGovernance\LifecycleWorkflows\Workflows\Item\MicrosoftGraphIdentityGovernancePreviewWorkflow\PreviewWorkflowPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\DirectoryObject;
use Microsoft\Graph\Beta\Generated\Models\User;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new PreviewWorkflowPostRequestBody();
$subjectsDirectoryObject1 = new User();
$subjectsDirectoryObject1->setOdataType('#microsoft.graph.user');
$subjectsDirectoryObject1->setId('b59552b8-fa7b-4f68-8496-0a529aace8c0');
$subjectsArray []= $subjectsDirectoryObject1;
$subjectsDirectoryObject2 = new User();
$subjectsDirectoryObject2->setOdataType('#microsoft.graph.user');
$subjectsDirectoryObject2->setId('a1b2c3d4-e5f6-7890-abcd-ef1234567890');
$subjectsArray []= $subjectsDirectoryObject2;
$requestBody->setSubjects($subjectsArray);
$graphServiceClient->identityGovernance()->lifecycleWorkflows()->workflows()->byWorkflowId('workflow-id')->microsoftGraphIdentityGovernancePreviewWorkflow()->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_preview_workflow.preview_workflow_post_request_body import PreviewWorkflowPostRequestBody
from msgraph_beta.generated.models.directory_object import DirectoryObject
from msgraph_beta.generated.models.user import User
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = PreviewWorkflowPostRequestBody(
subjects = [
User(
odata_type = "#microsoft.graph.user",
id = "b59552b8-fa7b-4f68-8496-0a529aace8c0",
),
User(
odata_type = "#microsoft.graph.user",
id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
),
],
)
await graph_client.identity_governance.lifecycle_workflows.workflows.by_workflow_id('workflow-id').microsoft_graph_identity_governance_preview_workflow.post(request_body)
Antwort
Das folgende Beispiel zeigt die Antwort.
HTTP/1.1 204 No Content