DurableOrchestrationClientBase.GetStatusAsync Method
Definition
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.
Overloads
| GetStatusAsync(String) |
Gets the status of the specified orchestration instance. |
| GetStatusAsync(CancellationToken) |
Gets all the status of the orchestration instances. |
| GetStatusAsync(String, Boolean) |
Gets the status of the specified orchestration instance. |
| GetStatusAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken) |
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(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, Int32, String, CancellationToken) |
Gets the status of all orchestration instances with paging that match the specified conditions. |
GetStatusAsync(String)
Gets the status of the specified orchestration instance.
public virtual System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.DurableOrchestrationStatus> GetStatusAsync(string instanceId);abstract member GetStatusAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>
override this.GetStatusAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>Public Overridable Function GetStatusAsync (instanceId As String) As Task(Of DurableOrchestrationStatus)Parameters
- instanceId
- System.String
The ID of the orchestration instance to query.
Returns
Returns a task which completes when the status has been fetched.
Applies to
GetStatusAsync(CancellationToken)
Gets all the status of the orchestration instances.
public abstract System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>> GetStatusAsync(System.Threading.CancellationToken cancellationToken = default);abstract member GetStatusAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>>Public MustOverride Function GetStatusAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of DurableOrchestrationStatus))Parameters
- cancellationToken
- System.Threading.CancellationToken
Cancellation token that can be used to cancel the status query operation.
Returns
Returns orchestration status for all instances.
Applies to
GetStatusAsync(String, Boolean)
Gets the status of the specified orchestration instance.
public virtual System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.DurableOrchestrationStatus> GetStatusAsync(string instanceId, bool showHistory);abstract member GetStatusAsync : string * bool -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>
override this.GetStatusAsync : string * bool -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>Public Overridable Function GetStatusAsync (instanceId As String, showHistory As Boolean) As Task(Of DurableOrchestrationStatus)Parameters
- instanceId
- System.String
The ID of the orchestration instance to query.
- showHistory
- System.Boolean
Boolean marker for including execution history in the response.
Returns
Returns a task which completes when the status has been fetched.
Applies to
GetStatusAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken)
Gets the status of all orchestration instances that match the specified conditions.
public abstract System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>> GetStatusAsync(DateTime createdTimeFrom, DateTime? createdTimeTo, System.Collections.Generic.IEnumerable<Microsoft.Azure.WebJobs.OrchestrationRuntimeStatus> runtimeStatus, System.Threading.CancellationToken cancellationToken = default);abstract member GetStatusAsync : DateTime * Nullable<DateTime> * seq<Microsoft.Azure.WebJobs.OrchestrationRuntimeStatus> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>>Public MustOverride Function GetStatusAsync (createdTimeFrom As DateTime, createdTimeTo As Nullable(Of DateTime), runtimeStatus As IEnumerable(Of OrchestrationRuntimeStatus), Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of DurableOrchestrationStatus))Parameters
- createdTimeFrom
- System.DateTime
Return orchestration instances which were created after this DateTime.
- createdTimeTo
- System.Nullable<System.DateTime>
Return orchestration instances which were created before this DateTime.
- runtimeStatus
- System.Collections.Generic.IEnumerable<OrchestrationRuntimeStatus>
Return orchestration instances which matches the runtimeStatus.
- cancellationToken
- System.Threading.CancellationToken
Cancellation token that can be used to cancel the status query operation.
Returns
Returns orchestration status for all instances.
Applies to
GetStatusAsync(String, Boolean, Boolean, Boolean)
Gets the status of the specified orchestration instance.
public abstract System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.DurableOrchestrationStatus> GetStatusAsync(string instanceId, bool showHistory, bool showHistoryOutput, bool showInput = true);abstract member GetStatusAsync : string * bool * bool * bool -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.DurableOrchestrationStatus>Public MustOverride Function GetStatusAsync (instanceId As String, showHistory As Boolean, showHistoryOutput As Boolean, Optional showInput As Boolean = true) As Task(Of DurableOrchestrationStatus)Parameters
- instanceId
- System.String
The ID of the orchestration instance to query.
- showHistory
- System.Boolean
Boolean marker for including execution history in the response.
- showHistoryOutput
- System.Boolean
Boolean marker for including input and output in the execution history response.
- showInput
- System.Boolean
If set, fetch and return the input for the orchestration instance.
Returns
Returns a task which completes when the status has been fetched.
Applies to
GetStatusAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationRuntimeStatus>, Int32, String, CancellationToken)
Gets the status of all orchestration instances with paging that match the specified conditions.
public abstract System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationStatusQueryResult> GetStatusAsync(DateTime createdTimeFrom, DateTime? createdTimeTo, System.Collections.Generic.IEnumerable<Microsoft.Azure.WebJobs.OrchestrationRuntimeStatus> runtimeStatus, int pageSize, string continuationToken, System.Threading.CancellationToken cancellationToken = default);abstract member GetStatusAsync : DateTime * Nullable<DateTime> * seq<Microsoft.Azure.WebJobs.OrchestrationRuntimeStatus> * int * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.OrchestrationStatusQueryResult>Public MustOverride Function GetStatusAsync (createdTimeFrom As DateTime, createdTimeTo As Nullable(Of DateTime), runtimeStatus As IEnumerable(Of OrchestrationRuntimeStatus), pageSize As Integer, continuationToken As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of OrchestrationStatusQueryResult)Parameters
- createdTimeFrom
- System.DateTime
Return orchestration instances which were created after this DateTime.
- createdTimeTo
- System.Nullable<System.DateTime>
Return orchestration instances which were created before this DateTime.
- runtimeStatus
- System.Collections.Generic.IEnumerable<OrchestrationRuntimeStatus>
Return orchestration instances which matches the runtimeStatus.
- pageSize
- System.Int32
Number of records per one request.
- continuationToken
- System.String
ContinuationToken of the pager.
- cancellationToken
- System.Threading.CancellationToken
Cancellation token that can be used to cancel the status query operation.
Returns
Returns each page of orchestration status for all instances and continuation token of next page.