Class DurableOrchestrationClient

Client for starting, querying, terminating, and raising events to orchestration instances.

Inheritance
System.Object
DurableOrchestrationClientBase
DurableOrchestrationClient
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Microsoft.Azure.WebJobs
Assembly: Microsoft.Azure.WebJobs.Extensions.DurableTask.dll
Syntax
public class DurableOrchestrationClient : DurableOrchestrationClientBase

Properties

| Improve this Doc View Source

TaskHubName

Gets the name of the task hub configured on this client instance.

Declaration
public override string TaskHubName { get; }
Property Value
Type Description
System.String

The name of the task hub.
Overrides

Methods

| Improve this Doc View Source

CreateCheckStatusResponse(HttpRequestMessage, String)

Creates an HTTP response that is useful for checking the status of the specified instance.

Declaration
public override HttpResponseMessage CreateCheckStatusResponse(HttpRequestMessage request, string instanceId)
Parameters
Type Name Description
System.Net.Http.HttpRequestMessage request

The HTTP request that triggered the current orchestration instance.
System.String instanceId

The ID of the orchestration instance to check.
Returns
Type Description
System.Net.Http.HttpResponseMessage

An HTTP 202 response with a Location header and a payload containing instance control URLs.
Overrides
Remarks

The payload of the returned System.Net.Http.HttpResponseMessage contains HTTP API URLs that can be used to query the status of the orchestration, raise events to the orchestration, or terminate the orchestration.

| Improve this Doc View Source

CreateHttpManagementPayload(String)

Creates a HttpManagementPayload object that contains status, terminate and send external event HTTP endpoints.

Declaration
public override HttpManagementPayload CreateHttpManagementPayload(string instanceId)
Parameters
Type Name Description
System.String instanceId

The ID of the orchestration instance to check.
Returns
Type Description
HttpManagementPayload

Instance of the HttpManagementPayload class.
Overrides
| Improve this Doc View Source

GetStatusAsync(String, Boolean, Boolean)

Gets the status of the specified orchestration instance.

Declaration
public override Task<DurableOrchestrationStatus> GetStatusAsync(string instanceId, bool showHistory = false, bool showHistoryOutput = false)
Parameters
Type Name Description
System.String instanceId

The ID of the orchestration instance to query.
System.Boolean showHistory

Boolean marker for including execution history in the response.
System.Boolean showHistoryOutput

Boolean marker for including input and output in the execution history response.
Returns
Type Description
System.Threading.Tasks.Task<DurableOrchestrationStatus>

Returns a task which completes when the status has been fetched.
Overrides
| Improve this Doc View Source

GetStatusAsync(CancellationToken)

Gets all the status of the orchestration instances.

Declaration
public override Task<IList<DurableOrchestrationStatus>> GetStatusAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

Cancellation token that can be used to cancel the status query operation.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<DurableOrchestrationStatus>>

Returns orchestration status for all instances.
Overrides
| Improve this Doc View Source

RaiseEventAsync(String, String, Object)

Sends an event notification message to a waiting orchestration instance.

Declaration
public override Task RaiseEventAsync(string instanceId, string eventName, object eventData)
Parameters
Type Name Description
System.String instanceId

The ID of the orchestration instance that will handle the event.
System.String eventName

The name of the event.
System.Object eventData

The JSON-serializeable data associated with the event.
Returns
Type Description
System.Threading.Tasks.Task

A task that completes when the event notification message has been enqueued.
Overrides
Remarks

In order to handle the event, the target orchestration instance must be waiting for an event named eventName using the WaitForExternalEvent<T>(String) API.

If the specified instance is not found or not running, this operation will have no effect.

| Improve this Doc View Source

StartNewAsync(String, String, Object)

Starts a new instance of the specified orchestrator function.

Declaration
public override Task<string> StartNewAsync(string orchestratorFunctionName, string instanceId, object input)
Parameters
Type Name Description
System.String orchestratorFunctionName

The name of the orchestrator function to start.
System.String instanceId

The ID to use for the new orchestration instance.
System.Object input

JSON-serializeable input value for the orchestrator function.
Returns
Type Description
System.Threading.Tasks.Task<System.String>

A task that completes when the orchestration is started.
Overrides
Remarks

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

Exceptions
Type Condition
System.ArgumentException

The specified function does not exist, is disabled, or is not an orchestrator function.
| Improve this Doc View Source

TerminateAsync(String, String)

Terminates a running orchestration instance.

Declaration
public override Task TerminateAsync(string instanceId, string reason)
Parameters
Type Name Description
System.String instanceId

The ID of the orchestration instance to terminate.
System.String reason

The reason for terminating the orchestration instance.
Returns
Type Description
System.Threading.Tasks.Task

A task that completes when the terminate message is enqueued.
Overrides
Remarks

Terminating an orchestration instance has no effect on any in-flight activity function executions or sub-orchestrations that were started by the current orchestration instance.

| Improve this Doc View Source

WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, TimeSpan, TimeSpan)

Creates an HTTP response which either contains a payload of management URLs for a non-completed instance or contains the payload containing the output of the completed orchestration.

Declaration
public override Task<HttpResponseMessage> WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage request, string instanceId, TimeSpan timeout, TimeSpan retryInterval)
Parameters
Type Name Description
System.Net.Http.HttpRequestMessage request

The HTTP request that triggered the current function.
System.String instanceId

The unique ID of the instance to check.
System.TimeSpan timeout

Total allowed timeout for output from the durable function. The default value is 10 seconds.
System.TimeSpan retryInterval

The timeout between checks for output from the durable function. The default value is 1 second.
Returns
Type Description
System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>

An HTTP response which may include a 202 and location header or a 200 with the durable function output in the response body.
Overrides
Remarks

If the orchestration instance completes within the specified timeout, then the HTTP response payload will contain the output of the orchestration instance formatted as JSON. However, if the orchestration does not complete within the specified timeout, then the HTTP response will be identical to that of the CreateCheckStatusResponse(HttpRequestMessage, String) API.