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

PurgeInstanceHistoryAsync(String)	Purge the history for a concrete instance.
PurgeInstanceHistoryAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationStatus>)	Purge the orchestration history for instances that match the conditions.

PurgeInstanceHistoryAsync(String)

Source:

IDurableOrchestrationClient.cs

Purge the history for a concrete instance.

public System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.PurgeHistoryResult> PurgeInstanceHistoryAsync (string instanceId);

abstract member PurgeInstanceHistoryAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.PurgeHistoryResult>

Public Function PurgeInstanceHistoryAsync (instanceId As String) As Task(Of PurgeHistoryResult)

Parameters

instanceId

String

The ID of the orchestration instance to purge.

Returns

Task<PurgeHistoryResult>

Returns an instance of PurgeHistoryResult.

PurgeInstanceHistoryAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationStatus>)

Source:

IDurableOrchestrationClient.cs

Purge the orchestration history for instances that match the conditions.

public System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.PurgeHistoryResult> PurgeInstanceHistoryAsync (DateTime createdTimeFrom, DateTime? createdTimeTo, System.Collections.Generic.IEnumerable<DurableTask.Core.OrchestrationStatus> runtimeStatus);

abstract member PurgeInstanceHistoryAsync : DateTime * Nullable<DateTime> * seq<DurableTask.Core.OrchestrationStatus> -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.Extensions.DurableTask.PurgeHistoryResult>

Public Function PurgeInstanceHistoryAsync (createdTimeFrom As DateTime, createdTimeTo As Nullable(Of DateTime), runtimeStatus As IEnumerable(Of OrchestrationStatus)) As Task(Of PurgeHistoryResult)

Parameters

createdTimeFrom

DateTime

Start creation time for querying instances for purging.

createdTimeTo

Nullable<DateTime>

End creation time for querying instances for purging.

runtimeStatus

IEnumerable<DurableTask.Core.OrchestrationStatus>

List of runtime status for querying instances for purging. Only Completed, Terminated, or Failed will be processed.

Returns

Task<PurgeHistoryResult>

Returns an instance of PurgeHistoryResult.