Workflow Runs - Cancel

Serviço:

App Service

Versão da API:

2025-05-01

Cancela uma execução de fluxo de trabalho.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel?api-version=2025-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome do site.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
runName	path	True	string	O nome da execução do fluxo de trabalho.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
workflowName	path	True	string	O nome do fluxo de trabalho.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK		Operação do Azure concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Cancel a workflow run

Pedido de amostra

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/test-workflow/runs/08586676746934337772206998657CU22/cancel?api-version=2025-05-01

Java

/**
 * Samples for WorkflowRuns Cancel.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/WorkflowRuns_Cancel.json
     */
    /**
     * Sample code: Cancel a workflow run.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void cancelAWorkflowRun(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getWorkflowRuns().cancelWithResponse("test-resource-group", "test-name",
            "test-workflow", "08586676746934337772206998657CU22", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/WorkflowRuns_Cancel.json
func ExampleWorkflowRunsClient_Cancel() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWorkflowRunsClient().Cancel(ctx, "test-resource-group", "test-name", "test-workflow", "08586676746934337772206998657CU22", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.WorkflowRunsClientCancelResponse{
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:

200

Definições

Name	Description
ErrorProperties	As propriedades de erro indicam por que o serviço Logic não pôde processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.
ErrorResponse	A resposta de erro indica que o serviço lógico não é capaz de processar a solicitação de entrada. A propriedade error contém os detalhes do erro.

ErrorProperties

Object

As propriedades de erro indicam por que o serviço Logic não pôde processar a solicitação de entrada. O motivo é fornecido na mensagem de erro.

Name	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

ErrorResponse

Object

A resposta de erro indica que o serviço lógico não é capaz de processar a solicitação de entrada. A propriedade error contém os detalhes do erro.

Name	Tipo	Description
error	ErrorProperties	As propriedades do erro.