workflow : cancelProcessing

Espace de noms : microsoft.graph.identityGovernance

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Annuler une ou plusieurs exécutions de flux de travail actuellement dans queued ou inProgress status. Actuellement limité à l’annulation d’une exécution par demande.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle de Microsoft Entra pris en charge ou un rôle personnalisé qui accorde les autorisations requises pour cette opération. L’administrateur des workflows de cycle de vie est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

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

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez une représentation JSON des paramètres.

Le tableau suivant présente les paramètres requis pour cette action.

Paramètre Type Description
étendue microsoft.graph.identityGovernance.cancelScope Définit l’étendue des exécutions de workflow à annuler. Actuellement, seul cancelRunsScope est pris en charge. Obligatoire.

propriétés cancelRunsScope

Lorsque vous utilisez cancelRunsScope, la @odata.type propriété est requise dans le corps de la requête.

Propriété Type Description
@odata.type String Doit être #microsoft.graph.identityGovernance.cancelRunsScope. Obligatoire.
Fonctionne collection microsoft.graph.identityGovernance.run Le flux de travail s’exécute pour l’annuler. Actuellement limité à une exécution par demande. Obligatoire.

Réponse

Si elle réussit, cette action renvoie un code de réponse 204 No Content.

Exemples

Exemple 1 : Annulation réussie d’une exécution de workflow

L’exemple suivant montre une requête qui annule correctement une seule exécution de workflow.

Demande

L’exemple suivant illustre une demande.

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"
      }
    ]
  }
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content