IDurableOrchestrationContext.CallSubOrchestratorAsync Method

Definition

Namespace:

Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:

Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Overloads

CallSubOrchestratorAsync(String, Object)	Schedules an orchestrator function named functionName for execution.
CallSubOrchestratorAsync(String, String, Object)	Schedules an orchestrator function named functionName for execution.
CallSubOrchestratorAsync<TResult>(String, Object)	Schedules an orchestrator function named functionName for execution.
CallSubOrchestratorAsync<TResult>(String, String, Object)	Schedules an orchestration function named functionName for execution.

CallSubOrchestratorAsync(String, Object)

Source:

IDurableOrchestrationContext.cs

Schedules an orchestrator function named functionName for execution.

public System.Threading.Tasks.Task CallSubOrchestratorAsync (string functionName, object input);

abstract member CallSubOrchestratorAsync : string * obj -> System.Threading.Tasks.Task

Public Function CallSubOrchestratorAsync (functionName As String, input As Object) As Task

Parameters

functionName

String

The name of the orchestrator function to call.

input

Object

The JSON-serializeable input to pass to the orchestrator function.

Returns

Task

A durable task that completes when the called orchestrator function completes or fails.

Exceptions

ArgumentException

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

InvalidOperationException

The current thread is different than the thread which started the orchestrator execution.

FunctionFailedException

The sub-orchestrator function failed with an unhandled exception.

CallSubOrchestratorAsync(String, String, Object)

Source:

IDurableOrchestrationContext.cs

Schedules an orchestrator function named functionName for execution.

public System.Threading.Tasks.Task CallSubOrchestratorAsync (string functionName, string instanceId, object input);

abstract member CallSubOrchestratorAsync : string * string * obj -> System.Threading.Tasks.Task

Public Function CallSubOrchestratorAsync (functionName As String, instanceId As String, input As Object) As Task

Parameters

functionName

String

The name of the orchestrator function to call.

instanceId

String

A unique ID to use for the sub-orchestration instance.

input

Object

The JSON-serializeable input to pass to the orchestrator function.

Returns

Task

A durable task that completes when the called orchestrator function completes or fails.

Exceptions

ArgumentException

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

InvalidOperationException

The current thread is different than the thread which started the orchestrator execution.

FunctionFailedException

The activity function failed with an unhandled exception.

CallSubOrchestratorAsync<TResult>(String, Object)

Source:

IDurableOrchestrationContext.cs

Schedules an orchestrator function named functionName for execution.

public System.Threading.Tasks.Task<TResult> CallSubOrchestratorAsync<TResult> (string functionName, object input);

abstract member CallSubOrchestratorAsync : string * obj -> System.Threading.Tasks.Task<'Result>

Public Function CallSubOrchestratorAsync(Of TResult) (functionName As String, input As Object) As Task(Of TResult)

Type Parameters

TResult

The return type of the scheduled orchestrator function.

Parameters

functionName

String

The name of the orchestrator function to call.

input

Object

The JSON-serializeable input to pass to the orchestrator function.

Returns

Task<TResult>

A durable task that completes when the called orchestrator function completes or fails.

Exceptions

ArgumentException

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

InvalidOperationException

The current thread is different than the thread which started the orchestrator execution.

FunctionFailedException

The sub-orchestrator function failed with an unhandled exception.

CallSubOrchestratorAsync<TResult>(String, String, Object)

Source:

IDurableOrchestrationContext.cs

Schedules an orchestration function named functionName for execution.

public System.Threading.Tasks.Task<TResult> CallSubOrchestratorAsync<TResult> (string functionName, string instanceId, object input);

abstract member CallSubOrchestratorAsync : string * string * obj -> System.Threading.Tasks.Task<'Result>

Public Function CallSubOrchestratorAsync(Of TResult) (functionName As String, instanceId As String, input As Object) As Task(Of TResult)

Type Parameters

TResult

The return type of the scheduled orchestrator function.

Parameters

functionName

String

The name of the orchestrator function to call.

instanceId

String

A unique ID to use for the sub-orchestration instance.

input

Object

The JSON-serializeable input to pass to the orchestrator function.

Returns

Task<TResult>

A durable task that completes when the called orchestrator function completes or fails.

Exceptions

ArgumentException

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

InvalidOperationException

The current thread is different than the thread which started the orchestrator execution.

FunctionFailedException

The activity function failed with an unhandled exception.