AIProjectRoutines.DispatchAsync Method

Definition

Queue an asynchronous routine dispatch.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.DispatchRoutineResult>> DispatchAsync(string name, Azure.AI.Projects.RoutineDispatchPayload payload = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DispatchAsync : string * Azure.AI.Projects.RoutineDispatchPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.DispatchRoutineResult>>
override this.DispatchAsync : string * Azure.AI.Projects.RoutineDispatchPayload * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.DispatchRoutineResult>>
Public Overridable Function DispatchAsync (name As String, Optional payload As RoutineDispatchPayload = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of DispatchRoutineResult))

Parameters

name
String

The unique name of the routine.

payload
RoutineDispatchPayload

A direct action-input override sent downstream when testing a routine.

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