fluxo de trabalho: cancelarProcessamento

Espaço de nomes: microsoft.graph.identityGovernance

Cancele uma ou mais execuções de fluxo de trabalho que estejam atualmente dentro queued ou inProgress status. Atualmente limitado ao cancelamento de uma execução por pedido.

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Ciclo de VidaWorkflows-Workflow.ReadWrite.All Ciclo de VidaWorkflows.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Ciclo de VidaWorkflows-Workflow.ReadWrite.All Ciclo de VidaWorkflows.ReadWrite.All

Importante

Para acesso delegado através de contas escolares ou profissionais, tem de ser atribuída ao utilizador com sessão iniciada uma função de Microsoft Entra suportada ou uma função personalizada que conceda as permissões necessárias para esta operação. O Administrador de Fluxos de Trabalho do Ciclo de Vida é a função com menos privilégios suportada para esta operação.

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON dos parâmetros.

A tabela seguinte mostra os parâmetros necessários com esta ação.

Parâmetro Tipo Descrição
scope microsoft.graph.identityGovernance.cancelScope Define o âmbito das execuções de fluxo de trabalho a cancelar. Atualmente, apenas cancelRunsScope é suportado. Obrigatório.

cancelRunsScope properties (propriedades cancelRunsScope)

Ao utilizar cancelRunsScope, a @odata.type propriedade é necessária no corpo do pedido.

Propriedade Tipo Descrição
@odata.type Cadeia de caracteres Deve ser #microsoft.graph.identityGovernance.cancelRunsScope. Obrigatório.
execuções microsoft.graph.identityGovernance.run collection O fluxo de trabalho é executado para cancelar. Atualmente limitado a uma execução por pedido. Obrigatório.

Resposta

Se tiver êxito, esta ação retornará um código de resposta 204 No Content.

Exemplos

Exemplo 1: cancelar com êxito uma execução de fluxo de trabalho

O exemplo seguinte mostra um pedido que cancela com êxito uma única execução de fluxo de trabalho.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/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"
      }
    ]
  }
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content
  • Last updated on