IDurableOrchestrationClient Interface

Definition

Namespace:

Microsoft.Azure.WebJobs.Extensions.DurableTask

Assembly:

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:

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

Source:

IDurableOrchestrationClient.cs

Provides functionality available to durable orchestration clients.

public interface IDurableOrchestrationClient

type IDurableOrchestrationClient = interface

Public Interface IDurableOrchestrationClient

Derived

Microsoft.Azure.WebJobs.Extensions.DurableTask.DurableOrchestrationClientBase

Microsoft.Azure.WebJobs.Extensions.DurableTask.IDurableClient

Properties

TaskHubName

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

Methods

CreateCheckStatusResponse(HttpRequest, String, Boolean)	Creates an HTTP response that is useful for checking the status of the specified instance.
CreateCheckStatusResponse(HttpRequestMessage, String, Boolean)	Creates an HTTP response that is useful for checking the status of the specified instance.
CreateHttpManagementPayload(String)	Creates a HttpManagementPayload object that contains status, terminate and send external event HTTP endpoints.
GetStatusAsync(Nullable<DateTime>, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken)	Obsolete. Gets the status of all orchestration instances that match the specified conditions.
GetStatusAsync(OrchestrationStatusQueryCondition, CancellationToken)	Obsolete. Gets the status of all orchestration instances with paging that match the specified conditions.
GetStatusAsync(String, Boolean, Boolean, Boolean)	Gets the status of the specified orchestration instance.
ListInstancesAsync(OrchestrationStatusQueryCondition, CancellationToken)	Gets the status of all orchestration instances with paging that match the specified conditions.
MakeCurrentAppPrimaryAsync()	Makes the current app the primary app, if it isn't already. Must be using the AppLease feature by setting UseAppLease to true in host.json.
PurgeInstanceHistoryAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationStatus>)	Purge the orchestration history for instances that match the conditions.
PurgeInstanceHistoryAsync(String)	Purge the history for a concrete instance.
RaiseEventAsync(String, String, Object)	Sends an event notification message to a waiting orchestration instance.
RaiseEventAsync(String, String, String, Object, String)	Sends an event notification message to a waiting orchestration instance.
RestartAsync(String, Boolean)	Restarts an existing orchestrator with the original input.
ResumeAsync(String, String)	Resumes a suspended orchestration instance.
RewindAsync(String, String)	Obsolete. Rewinds the specified failed orchestration instance with a reason.
StartNewAsync(String, String)	Starts a new execution of the specified orchestrator function.
StartNewAsync<T>(String, String, T)	Starts a new instance of the specified orchestrator function.
StartNewAsync<T>(String, T)	Starts a new execution of the specified orchestrator function.
SuspendAsync(String, String)	Suspends a running orchestration instance.
TerminateAsync(String, String)	Terminates a running orchestration instance.
WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequest, String, Nullable<TimeSpan>, Nullable<TimeSpan>, Boolean)	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.
WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, Nullable<TimeSpan>, Nullable<TimeSpan>, Boolean)	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.