DeidentificationClient.GetJobAsync Method

Definition

Namespace:

Azure.Health.Deidentification

Assembly:

Azure.Health.Deidentification.dll

Package:

Azure.Health.Deidentification v1.0.0-beta.1

Overloads

GetJobAsync(String, RequestContext)	[Protocol Method] Get a de-identification job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetJobAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetJobAsync(String, CancellationToken)	Get a de-identification job.

GetJobAsync(String, RequestContext)

Source:

DeidentificationClient.cs

[Protocol Method] Get a de-identification job.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler GetJobAsync(String, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> GetJobAsync (string name, Azure.RequestContext context);

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

Public Overridable Function GetJobAsync (name As String, context As RequestContext) As Task(Of Response)

Parameters

name

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

name is null.

ArgumentException

name 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 GetJobAsync and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);

Response response = await client.GetJobAsync("<name>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("sourceLocation").GetProperty("location").ToString());
Console.WriteLine(result.GetProperty("sourceLocation").GetProperty("prefix").ToString());
Console.WriteLine(result.GetProperty("targetLocation").GetProperty("location").ToString());
Console.WriteLine(result.GetProperty("targetLocation").GetProperty("prefix").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("createdAt").ToString());

This sample shows how to call GetJobAsync with all parameters and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);

Response response = await client.GetJobAsync("<name>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("sourceLocation").GetProperty("location").ToString());
Console.WriteLine(result.GetProperty("sourceLocation").GetProperty("prefix").ToString());
Console.WriteLine(result.GetProperty("sourceLocation").GetProperty("extensions")[0].ToString());
Console.WriteLine(result.GetProperty("targetLocation").GetProperty("location").ToString());
Console.WriteLine(result.GetProperty("targetLocation").GetProperty("prefix").ToString());
Console.WriteLine(result.GetProperty("operation").ToString());
Console.WriteLine(result.GetProperty("dataType").ToString());
Console.WriteLine(result.GetProperty("redactionFormat").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedAt").ToString());
Console.WriteLine(result.GetProperty("createdAt").ToString());
Console.WriteLine(result.GetProperty("startedAt").ToString());
Console.WriteLine(result.GetProperty("summary").GetProperty("successful").ToString());
Console.WriteLine(result.GetProperty("summary").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("summary").GetProperty("canceled").ToString());
Console.WriteLine(result.GetProperty("summary").GetProperty("total").ToString());
Console.WriteLine(result.GetProperty("summary").GetProperty("bytesProcessed").ToString());

GetJobAsync(String, CancellationToken)

Source:

DeidentificationClient.cs

Get a de-identification job.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Health.Deidentification.DeidentificationJob>> GetJobAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetJobAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Health.Deidentification.DeidentificationJob>>
override this.GetJobAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Health.Deidentification.DeidentificationJob>>

Public Overridable Function GetJobAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DeidentificationJob))

Parameters

name

String

The name of a job.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<DeidentificationJob>>

Exceptions

ArgumentNullException

name is null.

ArgumentException

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

Examples

This sample shows how to call GetJobAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);

Response<DeidentificationJob> response = await client.GetJobAsync("<name>");

This sample shows how to call GetJobAsync with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);

Response<DeidentificationJob> response = await client.GetJobAsync("<name>");

Remarks

Resource read operation template.