workflow: cancelProcessing

Espacio de nombres: microsoft.graph.identityGovernance

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Cancele una o varias ejecuciones de flujo de trabajo que están actualmente en queued estado o inProgress . Actualmente está limitado a cancelar una ejecución por solicitud.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación LifecycleWorkflows-Workflow.ReadWrite.All LifecycleWorkflows.ReadWrite.All

Importante

Para el acceso delegado mediante cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado que conceda los permisos necesarios para esta operación. Administrador de flujos de trabajo de ciclo de vida es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

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

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON de los parámetros.

En la tabla siguiente se muestran los parámetros necesarios con esta acción.

Parámetro Tipo Descripción
ámbito microsoft.graph.identityGovernance.cancelScope Define el ámbito de las ejecuciones de flujo de trabajo que se van a cancelar. Actualmente solo se admite cancelRunsScope . Obligatorio.

propiedades cancelRunsScope

Cuando se usa cancelRunsScope, la @odata.type propiedad es necesaria en el cuerpo de la solicitud.

Propiedad Tipo Descripción
@odata.type Cadena Debe ser #microsoft.graph.identityGovernance.cancelRunsScope. Obligatorio.
ejecuciones Colección microsoft.graph.identityGovernance.run El flujo de trabajo se ejecuta para cancelar. Actualmente está limitado a una ejecución por solicitud. Obligatorio.

Respuesta

Si se ejecuta correctamente, esta acción devuelve un código de respuesta 204 No Content.

Ejemplos

Ejemplo 1: Cancelación correcta de una ejecución de flujo de trabajo

En el ejemplo siguiente se muestra una solicitud que cancela correctamente una única ejecución de flujo de trabajo.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content