DeidentificationClient.CancelJob Method
Definition
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.
Overloads
| CancelJob(String, RequestContext) |
[Protocol Method] Cancel a de-identification job.
|
| CancelJob(String, CancellationToken) |
Cancel a de-identification job. |
CancelJob(String, RequestContext)
[Protocol Method] Cancel 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 CancelJob(String, CancellationToken) convenience overload with strongly typed models first.
public virtual Azure.Response CancelJob (string name, Azure.RequestContext context);abstract member CancelJob : string * Azure.RequestContext -> Azure.Response
override this.CancelJob : string * Azure.RequestContext -> Azure.ResponsePublic Overridable Function CancelJob (name As String, context As RequestContext) As ResponseParameters
- 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
The response returned from the service.
Exceptions
name is null.
name is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call CancelJob 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 = client.CancelJob("<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 CancelJob 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 = client.CancelJob("<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());
Applies to
CancelJob(String, CancellationToken)
Cancel a de-identification job.
public virtual Azure.Response<Azure.Health.Deidentification.DeidentificationJob> CancelJob (string name, System.Threading.CancellationToken cancellationToken = default);abstract member CancelJob : string * System.Threading.CancellationToken -> Azure.Response<Azure.Health.Deidentification.DeidentificationJob>
override this.CancelJob : string * System.Threading.CancellationToken -> Azure.Response<Azure.Health.Deidentification.DeidentificationJob>Public Overridable Function CancelJob (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DeidentificationJob)Parameters
- name
- String
The name of a job.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
name is null.
name is an empty string, and was expected to be non-empty.
Examples
This sample shows how to call CancelJob.
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);
Response<DeidentificationJob> response = client.CancelJob("<name>");
This sample shows how to call CancelJob 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 = client.CancelJob("<name>");
Remarks
Cancels a job that is in progress.
The job will be marked as canceled and the service will stop processing the job. The service will not delete any documents that have already been processed.
If the job is already complete, this will have no effect.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure SDK for .NET