Class DurableOrchestrationStatus

Namespace

Microsoft.Azure.WebJobs

Assembly

Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Represents the status of a durable orchestration instance.

public class DurableOrchestrationStatus

Inheritance

object

DurableOrchestrationStatus

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

An external client can fetch the status of an orchestration instance using GetStatusAsync(string, bool, bool, bool).

Constructors

DurableOrchestrationStatus()

public DurableOrchestrationStatus()

Properties

CreatedTime

Gets the time at which the orchestration instance was created.

public DateTime CreatedTime { get; set; }

Property Value

DateTime

The instance creation time in UTC.

Remarks

If the orchestration instance is in the Pending status, this time represents the time at which the orchestration instance was scheduled.

CustomStatus

Gets the custom status payload (if any) that was set by the orchestrator function.

public JToken CustomStatus { get; set; }

Property Value

JToken

The custom status as either a JToken object or null if no custom status has been set.

Remarks

Orchestrator functions can set a custom status using SetCustomStatus(object).

History

Gets the execution history of the orchestration instance.

public JArray History { get; set; }

Property Value

JArray

The output as a JArray object or null.

Remarks

The history log can be large and is therefore null by default. It is populated only when explicitly requested in the call to GetStatusAsync(string, bool, bool, bool).

Input

Gets the input of the orchestrator function instance.

public JToken Input { get; set; }

Property Value

JToken

The input as either a JToken or null if no input was provided.

InstanceId

Gets the ID of the queried orchestration instance.

public string InstanceId { get; set; }

Property Value

string

The unique ID of the instance.

Remarks

The instance ID is generated and fixed when the orchestrator function is scheduled. It can be either auto-generated, in which case it is formatted as a GUID, or it can be user-specified with any format.

LastUpdatedTime

Gets the time at which the orchestration instance last updated its execution history.

public DateTime LastUpdatedTime { get; set; }

Property Value

DateTime

The last-updated time in UTC.

Name

Gets the name of the queried orchestrator function.

public string Name { get; set; }

Property Value

string

The orchestrator function name.

Output

Gets the output of the queried orchestration instance.

public JToken Output { get; set; }

Property Value

JToken

The output as either a JToken object or null if it has not yet completed.

RuntimeStatus

Gets the runtime status of the queried orchestration instance.

public OrchestrationRuntimeStatus RuntimeStatus { get; set; }

Property Value

OrchestrationRuntimeStatus

Expected values include Running, Pending, Failed, Canceled, Terminated, Completed.