Evaluations.CancelAsync 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
| CancelAsync(String, String, RequestOptions) |
[Protocol Method] Cancel an evaluation run by name
|
| CancelAsync(String, String, CancellationToken) |
Cancel an evaluation run by name. |
CancelAsync(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.Threading.Tasks.Task<System.ClientModel.ClientResult> CancelAsync(string name, string clientRequestId, System.ClientModel.Primitives.RequestOptions options);abstract member CancelAsync : string * string * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.CancelAsync : string * string * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>Public Overridable Function CancelAsync (name As String, clientRequestId As String, options As RequestOptions) As Task(Of 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
CancelAsync(String, String, CancellationToken)
- Source:
- Evaluations.cs
Cancel an evaluation run by name.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> CancelAsync(string name, string clientRequestId = default, System.Threading.CancellationToken cancellationToken = default);abstract member CancelAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.CancelAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>Public Overridable Function CancelAsync (name As String, Optional clientRequestId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.
