DeidentificationClient.DeleteJobAsync 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
| DeleteJobAsync(String, RequestContext) |
[Protocol Method] Removes the record of the job from the service. Does not delete any documents.
|
| DeleteJobAsync(String, CancellationToken) |
Removes the record of the job from the service. Does not delete any documents. |
DeleteJobAsync(String, RequestContext)
- Source:
- DeidentificationClient.cs
- Source:
- DeidentificationClient.cs
[Protocol Method] Removes the record of the job from the service. Does not delete any documents.
- 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);public virtual System.Threading.Tasks.Task<Azure.Response> DeleteJobAsync(string jobName, Azure.RequestContext context);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)Public Overridable Function DeleteJobAsync (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 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);
Applies to
DeleteJobAsync(String, CancellationToken)
- Source:
- DeidentificationClient.cs
Removes the record of the job from the service. Does not delete any documents.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteJobAsync(string jobName, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteJobAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteJobAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteJobAsync (jobName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)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.
