DurableOrchestrationClientBase.PurgeInstanceHistoryAsync 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
| 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. |
PurgeInstanceHistoryAsync(DateTime, Nullable<DateTime>, IEnumerable<OrchestrationStatus>)
Purge the orchestration history for instances that match the conditions.
public abstract System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.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.PurgeHistoryResult>Public MustOverride Function PurgeInstanceHistoryAsync (createdTimeFrom As DateTime, createdTimeTo As Nullable(Of DateTime), runtimeStatus As IEnumerable(Of OrchestrationStatus)) As Task(Of PurgeHistoryResult)Parameters
- createdTimeFrom
- System.DateTime
Start creation time for querying instances for purging.
- createdTimeTo
- System.Nullable<System.DateTime>
End creation time for querying instances for purging.
- runtimeStatus
- System.Collections.Generic.IEnumerable<DurableTask.Core.OrchestrationStatus>
List of runtime status for querying instances for purging. Only Completed, Terminated, or Failed will be processed.
Returns
Returns an instance of PurgeHistoryResult.
Applies to
PurgeInstanceHistoryAsync(String)
Purge the history for a concrete instance.
public abstract System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.PurgeHistoryResult> PurgeInstanceHistoryAsync(string instanceId);abstract member PurgeInstanceHistoryAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.WebJobs.PurgeHistoryResult>Public MustOverride Function PurgeInstanceHistoryAsync (instanceId As String) As Task(Of PurgeHistoryResult)Parameters
- instanceId
- System.String
The ID of the orchestration instance to purge.
Returns
Returns an instance of PurgeHistoryResult.