Share via


Evaluations.Cancel Method

Definition

Overloads

Cancel(String, String, RequestOptions)

[Protocol Method] Cancel an evaluation run by name

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Cancel(String, String, CancellationToken)

Cancel an evaluation run by name.

Cancel(String, String, RequestOptions)

Source:
Evaluations.cs

[Protocol Method] Cancel an evaluation run by name

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.ClientModel.ClientResult Cancel(string name, string clientRequestId, System.ClientModel.Primitives.RequestOptions options);
abstract member Cancel : string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
override this.Cancel : string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
Public Overridable Function Cancel (name As String, clientRequestId As String, options As RequestOptions) As ClientResult

Parameters

name
String

Identifier of the evaluation.

clientRequestId
String

An opaque, globally-unique, client-generated string identifier for the request.

options
RequestOptions

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

name is null.

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

Service returned a non-success status code.

Applies to

Cancel(String, String, CancellationToken)

Source:
Evaluations.cs

Cancel an evaluation run by name.

public virtual System.ClientModel.ClientResult Cancel(string name, string clientRequestId = default, System.Threading.CancellationToken cancellationToken = default);
abstract member Cancel : string * string * System.Threading.CancellationToken -> System.ClientModel.ClientResult
override this.Cancel : string * string * System.Threading.CancellationToken -> System.ClientModel.ClientResult
Public Overridable Function Cancel (name As String, Optional clientRequestId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClientResult

Parameters

name
String

Identifier of the evaluation.

clientRequestId
String

An opaque, globally-unique, client-generated string identifier for the request.

cancellationToken
CancellationToken

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

Returns

Exceptions

name is null.

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

Service returned a non-success status code.

Applies to