WorkflowRunClient.Cancel(Guid, RequestContent, RequestContext) Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Workflows

Assembly:: Azure.Analytics.Purview.Workflows.dll

Package:: Azure.Analytics.Purview.Workflows v1.0.0-beta.2

Source:: WorkflowRunClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[Protocol Method] Cancel a workflow run.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual Azure.Response Cancel (Guid workflowRunId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member Cancel : Guid * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.Cancel : Guid * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response

Public Overridable Function Cancel (workflowRunId As Guid, content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

workflowRunId: Guid

The workflow run id.

content: RequestContent

The content to send as the body of the request.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call Cancel.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
WorkflowRunClient client = new WorkflowRunClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new object());
Response response = client.Cancel(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), content);

Console.WriteLine(response.Status);

This sample shows how to call Cancel with all parameters and request content.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
WorkflowRunClient client = new WorkflowRunClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    comment = "<comment>",
});
Response response = client.Cancel(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"), content);

Console.WriteLine(response.Status);

Applies to

Share via