WorkflowClient.DeleteAsync(Guid, RequestContext) Method

Definition

Namespace:

Azure.Analytics.Purview.Workflows

Assembly:

Azure.Analytics.Purview.Workflows.dll

Package:

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

Source:

WorkflowClient.cs

[Protocol Method] Delete a workflow.

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

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteAsync (Guid workflowId, Azure.RequestContext context = default);

abstract member DeleteAsync : Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteAsync : Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteAsync (workflowId As Guid, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

workflowId

Guid

The workflow id.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DeleteAsync.

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

Response response = await client.DeleteAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"));

Console.WriteLine(response.Status);

This sample shows how to call DeleteAsync with all parameters.

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

Response response = await client.DeleteAsync(Guid.Parse("73f411fe-4f43-4b4b-9cbd-6828d8f4cf9a"));

Console.WriteLine(response.Status);