IDurableOrchestrationClient.GetStatusAsync 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

GetStatusAsync(OrchestrationStatusQueryCondition, CancellationToken)	Obsolete. Gets the status of all orchestration instances with paging that match the specified conditions.
GetStatusAsync(Nullable<DateTime>, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken)	Obsolete. Gets the status of all orchestration instances that match the specified conditions.
GetStatusAsync(String, Boolean, Boolean, Boolean)	Gets the status of the specified orchestration instance.

GetStatusAsync(OrchestrationStatusQueryCondition, CancellationToken)

Source:

IDurableOrchestrationClient.cs

Caution

This API is now deprecated.

Gets the status of all orchestration instances with paging that match the specified conditions.

[System.Obsolete]
public System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationStatusQueryResult> GetStatusAsync (Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationStatusQueryCondition condition, System.Threading.CancellationToken cancellationToken);

[<System.Obsolete>]
abstract member GetStatusAsync : Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationStatusQueryCondition * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationStatusQueryResult>

Public Function GetStatusAsync (condition As OrchestrationStatusQueryCondition, cancellationToken As CancellationToken) As Task(Of OrchestrationStatusQueryResult)

Parameters

condition

OrchestrationStatusQueryCondition

Return orchestration instances that match the specified conditions.

cancellationToken

CancellationToken

Cancellation token that can be used to cancel the status query operation.

Returns

Task<OrchestrationStatusQueryResult>

Returns each page of orchestration status for all instances and continuation token of next page.

Attributes

ObsoleteAttribute

GetStatusAsync(Nullable<DateTime>, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken)

Source:

IDurableOrchestrationClient.cs

Caution

This API is now deprecated.

Gets the status of all orchestration instances that match the specified conditions.

[System.Obsolete]
public System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.WebJobs.Extensions.DurableTask.DurableOrchestrationStatus>> GetStatusAsync (DateTime? createdTimeFrom = default, DateTime? createdTimeTo = default, System.Collections.Generic.IEnumerable<Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationRuntimeStatus> runtimeStatus = default, System.Threading.CancellationToken cancellationToken = default);

[<System.Obsolete>]
abstract member GetStatusAsync : Nullable<DateTime> * Nullable<DateTime> * seq<Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationRuntimeStatus> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.WebJobs.Extensions.DurableTask.DurableOrchestrationStatus>>

Public Function GetStatusAsync (Optional createdTimeFrom As Nullable(Of DateTime) = Nothing, Optional createdTimeTo As Nullable(Of DateTime) = Nothing, Optional runtimeStatus As IEnumerable(Of OrchestrationRuntimeStatus) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of DurableOrchestrationStatus))

Parameters

createdTimeFrom

Nullable<DateTime>

If specified, return orchestration instances which were created after this DateTime.

createdTimeTo

Nullable<DateTime>

If specified, return orchestration instances which were created before this DateTime.

runtimeStatus

IEnumerable<OrchestrationRuntimeStatus>

If specified, return orchestration instances which matches the runtimeStatus.

cancellationToken

CancellationToken

If specified, this ancellation token can be used to cancel the status query operation.

Returns

Task<IList<DurableOrchestrationStatus>>

Returns orchestration status for all instances.

Attributes

ObsoleteAttribute

GetStatusAsync(String, Boolean, Boolean, Boolean)

Source:

IDurableOrchestrationClient.cs

Gets the status of the specified orchestration instance.

public System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.DurableOrchestrationStatus> GetStatusAsync (string instanceId, bool showHistory = false, bool showHistoryOutput = false, bool showInput = true);

abstract member GetStatusAsync : string * bool * bool * bool -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.DurableOrchestrationStatus>

Public Function GetStatusAsync (instanceId As String, Optional showHistory As Boolean = false, Optional showHistoryOutput As Boolean = false, Optional showInput As Boolean = true) As Task(Of DurableOrchestrationStatus)

Parameters

instanceId

String

The ID of the orchestration instance to query.

showHistory

Boolean

Boolean marker for including execution history in the response.

showHistoryOutput

Boolean

Boolean marker for including input and output in the execution history response.

showInput

Boolean

If set, fetch and return the input for the orchestration instance.

Returns

Task<DurableOrchestrationStatus>

Returns a task which completes when the status has been fetched.