IDurableOrchestrationClient.StartNewAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.WebJobs.Extensions.DurableTask
Assembly:
Microsoft.Azure.WebJobs.Extensions.DurableTask.dll
Package:
Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Overloads

StartNewAsync(String, String)

Starts a new execution of the specified orchestrator function.
StartNewAsync<T>(String, T)

Starts a new execution of the specified orchestrator function.
StartNewAsync<T>(String, String, T)

Starts a new instance of the specified orchestrator function.

StartNewAsync(String, String)

Source:
IDurableOrchestrationClient.cs

Starts a new execution of the specified orchestrator function.

public System.Threading.Tasks.Task<string> StartNewAsync (string orchestratorFunctionName, string instanceId = default);
abstract member StartNewAsync : string * string -> System.Threading.Tasks.Task<string>
Public Function StartNewAsync (orchestratorFunctionName As String, Optional instanceId As String = Nothing) As Task(Of String)

Parameters

orchestratorFunctionName
String

The name of the orchestrator function to start.

instanceId
String

The ID to use for the new orchestration instance.

Returns

Task<String>

A task that completes when the orchestration is started. The task contains the instance id of the started orchestratation instance.

Exceptions

ArgumentException

The specified function does not exist, is disabled, or is not an orchestrator function.

Applies to

StartNewAsync<T>(String, T)

Source:
IDurableOrchestrationClient.cs

Starts a new execution of the specified orchestrator function.

public System.Threading.Tasks.Task<string> StartNewAsync<T> (string orchestratorFunctionName, T input) where T : class;
abstract member StartNewAsync : string * 'T -> System.Threading.Tasks.Task<string> (requires 'T : null)
Public Function StartNewAsync(Of T As Class) (orchestratorFunctionName As String, input As T) As Task(Of String)

Type Parameters

T

The type of the input value for the orchestrator function.

Parameters

orchestratorFunctionName
String

The name of the orchestrator function to start.

input
T

JSON-serializeable input value for the orchestrator function.

Returns

Task<String>

A task that completes when the orchestration is started. The task contains the instance id of the started orchestratation instance.

Exceptions

ArgumentException

The specified function does not exist, is disabled, or is not an orchestrator function.

Applies to

StartNewAsync<T>(String, String, T)

Source:
IDurableOrchestrationClient.cs

Starts a new instance of the specified orchestrator function.

public System.Threading.Tasks.Task<string> StartNewAsync<T> (string orchestratorFunctionName, string instanceId, T input);
abstract member StartNewAsync : string * string * 'T -> System.Threading.Tasks.Task<string>
Public Function StartNewAsync(Of T) (orchestratorFunctionName As String, instanceId As String, input As T) As Task(Of String)

Type Parameters

T

The type of the input value for the orchestrator function.

Parameters

orchestratorFunctionName
String

The name of the orchestrator function to start.

instanceId
String

The ID to use for the new orchestration instance.

input
T

JSON-serializable input value for the orchestrator function.

Returns

Task<String>

A task that completes when the orchestration is started. The task contains the instance id of the started orchestratation instance.

Exceptions

ArgumentException

The specified function does not exist, is disabled, or is not an orchestrator function.

Remarks

If an orchestration instance with the specified ID already exists, the existing instance will be silently replaced by this new instance.

Applies to