DurableTaskClient.PurgeAllInstancesAsync 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.
Purges orchestration instances metadata from the durable store.
public abstract System.Threading.Tasks.Task<Microsoft.DurableTask.Client.PurgeResult> PurgeAllInstancesAsync (Microsoft.DurableTask.Client.PurgeInstancesFilter filter, System.Threading.CancellationToken cancellation = default);abstract member PurgeAllInstancesAsync : Microsoft.DurableTask.Client.PurgeInstancesFilter * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.DurableTask.Client.PurgeResult>Public MustOverride Function PurgeAllInstancesAsync (filter As PurgeInstancesFilter, Optional cancellation As CancellationToken = Nothing) As Task(Of PurgeResult)Parameters
- filter
- PurgeInstancesFilter
The filter for which orchestrations to purge.
- cancellation
- CancellationToken
A CancellationToken that can be used to cancel the purge operation.
Returns
This method returns a PurgeResult object after the operation has completed with a PurgedInstanceCount indicating the number of orchestration instances that were purged.