次の方法で共有

ワークフロー: cancelProcessing

名前空間: microsoft.graph.identityGovernance

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

現在queued状態またはinProgress状態にある 1 つ以上のワークフロー実行を取り消します。 現在、要求ごとに 1 回の実行を取り消すに制限されています。

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All

重要

職場または学校アカウントを使用した委任されたアクセスの場合、サインインしているユーザーには、サポートされているMicrosoft Entraロールまたはこの操作に必要なアクセス許可を付与するカスタム ロールが割り当てられている必要があります。 ライフサイクル ワークフロー管理者 は、この操作でサポートされる最小限の特権ロールです。

HTTP 要求

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

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で、パラメーターの JSON 表現を指定します。

次の表は、このアクションで必要なパラメーターを示しています。

パラメーター 型 説明
スコープ microsoft.graph.identityGovernance.cancelScope 取り消すワークフロー実行のスコープを定義します。 現在 、cancelRunsScope のみがサポートされています。 必須です。

cancelRunsScope プロパティ

cancelRunsScope を使用する場合は、要求本文に @odata.type プロパティが必要です。

プロパティ 型 説明
@odata.type 文字列 #microsoft.graph.identityGovernance.cancelRunsScope である必要があります。 必須です。
実行 microsoft.graph.identityGovernance.run コレクション ワークフローが実行され、取り消されます。 現在、要求ごとに 1 回の実行に制限されています。 必須です。

応答

成功した場合、このアクションは 204 No Content 応答コードを返します。

例

例 1: ワークフローの実行を正常に取り消す

次の例は、1 つのワークフロー実行を正常に取り消す要求を示しています。

要求

次の例は要求を示しています。

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

応答

次の例は応答を示しています。

HTTP/1.1 204 No Content
  • Last updated on