DeidentificationClient.CancelJobAsync 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
| CancelJobAsync(String, RequestContext) |
[Protocol Method] 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.
|
| CancelJobAsync(String, CancellationToken) |
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. |
CancelJobAsync(String, RequestContext)
- Source:
- DeidentificationClient.cs
- Source:
- DeidentificationClient.cs
[Protocol Method] 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.
- 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> CancelJobAsync(string jobName, Azure.RequestContext context);abstract member CancelJobAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CancelJobAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function CancelJobAsync (jobName As String, context As RequestContext) As Task(Of Response)Parameters
- jobName
- String
The name of a job.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
jobName is null.
jobName 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 CancelJobAsync and parse the result.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);
Response response = await client.CancelJobAsync("job_smith_documents_1", 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());
Applies to
CancelJobAsync(String, CancellationToken)
- Source:
- DeidentificationClient.cs
- Source:
- DeidentificationClient.cs
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.
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Health.Deidentification.DeidentificationJob>> CancelJobAsync(string jobName, System.Threading.CancellationToken cancellationToken = default);abstract member CancelJobAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Health.Deidentification.DeidentificationJob>>
override this.CancelJobAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Health.Deidentification.DeidentificationJob>>Public Overridable Function CancelJobAsync (jobName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DeidentificationJob))Parameters
- jobName
- String
The name of a job.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
jobName is null.
jobName 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 CancelJobAsync.
Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);
Response<DeidentificationJob> response = await client.CancelJobAsync("job_smith_documents_1");
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.
