JobRouterClient.DeleteJobAsync(String, RequestContext) Method

Reference

Definition

Namespace:: Azure.Communication.JobRouter

Assembly:: Azure.Communication.JobRouter.dll

Package:: Azure.Communication.JobRouter v1.0.0

Package:: Azure.Communication.JobRouter v1.1.0-beta.1

Source:: JobRouterClient.cs

Source:: JobRouterClient.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] Deletes a job and all of its traces.

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> DeleteJobAsync (string jobId, Azure.RequestContext context = default);

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

Public Overridable Function DeleteJobAsync (jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

jobId: String

Id of a job.

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

ArgumentNullException

jobId is null.

ArgumentException

jobId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Applies to

Share via