DurableTaskClientExtensions.PurgeInstancesAsync 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
| PurgeInstancesAsync(DurableTaskClient, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken) |
Purges orchestration instances metadata from the durable store. |
| PurgeInstancesAsync(DurableTaskClient, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken) |
Purges orchestration instances metadata from the durable store. |
PurgeInstancesAsync(DurableTaskClient, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, CancellationToken)
Purges orchestration instances metadata from the durable store.
public static System.Threading.Tasks.Task<Microsoft.DurableTask.Client.PurgeResult> PurgeInstancesAsync (this Microsoft.DurableTask.Client.DurableTaskClient client, DateTimeOffset? createdFrom, DateTimeOffset? createdTo, System.Threading.CancellationToken cancellation = default);static member PurgeInstancesAsync : Microsoft.DurableTask.Client.DurableTaskClient * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.DurableTask.Client.PurgeResult><Extension()>
Public Function PurgeInstancesAsync (client As DurableTaskClient, createdFrom As Nullable(Of DateTimeOffset), createdTo As Nullable(Of DateTimeOffset), Optional cancellation As CancellationToken = Nothing) As Task(Of PurgeResult)Parameters
- client
- DurableTaskClient
The DurableTask client.
- createdFrom
- Nullable<DateTimeOffset>
Filter purging to orchestrations after this date.
- createdTo
- Nullable<DateTimeOffset>
Filter purging to orchestrations before this date.
- cancellation
- CancellationToken
The cancellation token.
Returns
This method returns a PurgeResult object after the operation has completed with a
PurgedInstanceCount value of 1 or 0, depending on whether the target
instance was successfully purged.
Applies to
PurgeInstancesAsync(DurableTaskClient, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, IEnumerable<OrchestrationRuntimeStatus>, CancellationToken)
Purges orchestration instances metadata from the durable store.
public static System.Threading.Tasks.Task<Microsoft.DurableTask.Client.PurgeResult> PurgeInstancesAsync (this Microsoft.DurableTask.Client.DurableTaskClient client, DateTimeOffset? createdFrom, DateTimeOffset? createdTo, System.Collections.Generic.IEnumerable<Microsoft.DurableTask.Client.OrchestrationRuntimeStatus>? statuses, System.Threading.CancellationToken cancellation = default);static member PurgeInstancesAsync : Microsoft.DurableTask.Client.DurableTaskClient * Nullable<DateTimeOffset> * Nullable<DateTimeOffset> * seq<Microsoft.DurableTask.Client.OrchestrationRuntimeStatus> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.DurableTask.Client.PurgeResult><Extension()>
Public Function PurgeInstancesAsync (client As DurableTaskClient, createdFrom As Nullable(Of DateTimeOffset), createdTo As Nullable(Of DateTimeOffset), statuses As IEnumerable(Of OrchestrationRuntimeStatus), Optional cancellation As CancellationToken = Nothing) As Task(Of PurgeResult)Parameters
- client
- DurableTaskClient
The DurableTask client.
- createdFrom
- Nullable<DateTimeOffset>
Filter purging to orchestrations after this date.
- createdTo
- Nullable<DateTimeOffset>
Filter purging to orchestrations before this date.
- statuses
- IEnumerable<OrchestrationRuntimeStatus>
Filter purging to orchestrations with these statuses.
- cancellation
- CancellationToken
The cancellation token.
Returns
This method returns a PurgeResult object after the operation has completed with a
PurgedInstanceCount value of 1 or 0, depending on whether the target
instance was successfully purged.