EvaluatorGenerationJobs.CancelAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.AI.Projects

Assembly:

Azure.AI.Projects.dll

Package:

Azure.AI.Projects v2.1.0-beta.3

Source:

EvaluatorGenerationJobs.cs

Cancels an evaluator generation job by its ID.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.EvaluatorGenerationJob>> CancelAsync(string jobId, System.Threading.CancellationToken cancellationToken = default);

abstract member CancelAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.EvaluatorGenerationJob>>
override this.CancelAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.EvaluatorGenerationJob>>

Public Overridable Function CancelAsync (jobId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of EvaluatorGenerationJob))

Parameters

jobId

String

The ID of the job to cancel.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Task<ClientResult<EvaluatorGenerationJob>>

Exceptions

ArgumentNullException

jobId is null.

ArgumentException

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

ClientResultException

Service returned a non-success status code.