DeidentificationClient.DeleteJobAsync(String, RequestContext) Method

Definition

Namespace:

Azure.Health.Deidentification

Assembly:

Azure.Health.Deidentification.dll

Package:

Azure.Health.Deidentification v1.0.0

Source:

DeidentificationClient.cs

[Protocol Method] Delete a de-identification job.

• 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 jobName, 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 (jobName As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

jobName

String

The name 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

jobName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DeleteJobAsync.

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

Response response = await client.DeleteJobAsync("job_smith_documents_1");

Console.WriteLine(response.Status);