workflow: cancelProcessing

Пространство имен: microsoft.graph.identityGovernance

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Отмена одного или нескольких запусков рабочих процессов , которые в настоящее время находятся в queued состоянии или inProgress . В настоящее время ограничивается отменой одного запуска на запрос.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All

Важно!

Для делегированного доступа с использованием рабочих или учебных учетных записей пользователю, выполнившего вход, необходимо назначить поддерживаемую роль Microsoft Entra или пользовательскую роль, которая предоставляет разрешения, необходимые для этой операции. Администратор рабочих процессов жизненного цикла — это наименее привилегированная роль, поддерживаемая для этой операции.

HTTP-запрос

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

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление параметров в формате JSON.

В следующей таблице показаны параметры, необходимые для этого действия.

Параметр Тип Описание
область microsoft.graph.identityGovernance.cancelScope Определяет область выполнения рабочих процессов для отмены. В настоящее время поддерживается только cancelRunsScope . Обязательно.

Свойства cancelRunsScope

При использовании cancelRunsScope@odata.type свойство является обязательным в тексте запроса.

Свойство Тип Описание
@odata.type String Должно быть задано значение #microsoft.graph.identityGovernance.cancelRunsScope. Обязательно.
Работает коллекция microsoft.graph.identityGovernance.run Рабочий процесс выполняется для отмены. В настоящее время ограничено одним выполнением на запрос. Обязательно.

Отклик

В случае успешного выполнения это действие возвращает код отклика 204 No Content.

Примеры

Пример 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