DurableOrchestrationClient Class

Definition

Namespace:: Microsoft.Azure.WebJobs

Assembly:: Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:: Microsoft.Azure.WebJobs.Extensions.DurableTask v1.8.3

Source:: DurableOrchestrationClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class DurableOrchestrationClient : Microsoft.Azure.WebJobs.DurableOrchestrationClientBase

type DurableOrchestrationClient = class
    inherit DurableOrchestrationClientBase

Public Class DurableOrchestrationClient
Inherits DurableOrchestrationClientBase

Inheritance: System.Object

DurableOrchestrationClientBase
DurableOrchestrationClient

Properties

TaskHubName

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

Methods

CreateCheckStatusResponse(HttpRequestMessage, String)	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(CancellationToken)	Gets all the status of the orchestration instances.
GetStatusAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken)	Gets the status of all orchestration instances that match the specified conditions.
GetStatusAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, Int32, String, CancellationToken)	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.
GetStatusAsync(String, Boolean)	Gets the status of the specified orchestration instance. (Inherited from DurableOrchestrationClientBase)
GetStatusAsync(String)	Gets the status of the specified orchestration instance. (Inherited from DurableOrchestrationClientBase)
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.
RaiseEventAsync(String, String)	Sends an event notification message to a waiting orchestration instance. (Inherited from DurableOrchestrationClientBase)
RewindAsync(String, String)	Rewinds the specified failed orchestration instance with a reason.
StartNewAsync(String, Object)	Starts a new execution of the specified orchestrator function. (Inherited from DurableOrchestrationClientBase)
StartNewAsync(String, String, Object)	Starts a new instance of the specified orchestrator function.
TerminateAsync(String, String)	Terminates a running orchestration instance.
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.
WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String, 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. (Inherited from DurableOrchestrationClientBase)
WaitForCompletionOrCreateCheckStatusResponseAsync(HttpRequestMessage, String)	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. (Inherited from DurableOrchestrationClientBase)

Applies to