Skip to content

Commit 3065808

Browse files
committed
tweaks for clarity
Signed-off-by: Hannah Hunter <[email protected]>
1 parent 883b8cb commit 3065808

File tree

1 file changed

+23
-25
lines changed

1 file changed

+23
-25
lines changed

articles/azure-functions/durable-task-scheduler/durable-task-scheduler-auto-purge.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,42 @@ ms.date: 04/17/2025
99

1010
Large volumes of completed orchestration instance data can lead to storage bloat, incur higher storage cost, and increase performance issues. The autopurge feature for Durable Task Scheduler offers a lightweight, configurable, and adoptable way to manage orchestration instance clean-up without manual intervention.
1111

12-
## How it works
12+
Autopurge runs asynchronously in the background to avoid using too many system resources and to prevent blocking or delaying other Durable Task operations. While autopurge doesn't run on a precise schedule, the clean-up rate roughly matches your orchestration scheduling rate.
1313

14-
You enable autopurge by defining retention policies that control how long to keep completed, failed, or canceled orchestrations. Once enabled, autopurge deletes orchestration instances older than the retention period you set.
14+
## Enable autopurge
1515

16-
Autopurge runs asynchronously in the background to avoid using too many system resources and blocking or delaying other Durable Task operations. While autopurge doesn't run on a precise schedule, the clean-up rate roughly matches your orchestration scheduling rate.
17-
18-
### Enable autopurge
16+
Enable autopurge by defining retention policies that control how long to keep completed, failed, or canceled orchestrations. Once enabled, autopurge deletes orchestration instances older than the retention period you set.
1917

2018
You can configure autopurge using:
2119

22-
- Azure Resource Manager: Retention Policy Spec
23-
- Azure CLI (coming soon)
24-
- Azure portal (coming soon)
20+
- Azure Resource Manager
21+
- Azure CLI
22+
- Azure portal
2523

2624
# [Azure Resource Manager](#tab/arm)
2725

28-
When configuring in Azure Resource Manager, you can set a *specific* retention policy. Specific policies are applied only to the `orchestrationState` specified.
26+
When configuring in Azure Resource Manager, you can set either a *specific* or a *default* retention policy. Retention value can range from 0 (purge immediately after completion) to any large number.
2927

30-
```json
31-
{
32-
"retentionPeriodInDays": 1,
33-
"orchestrationState": "Completed"
34-
}
35-
```
28+
- **Specific policies** are applied only to the `orchestrationState` specified.
3629

37-
In this example, the retention policy tells Durable Task Scheduler to keep completed orchestrations for 1 day, and purge the rest.
30+
```json
31+
{
32+
"retentionPeriodInDays": 1,
33+
"orchestrationState": "Completed"
34+
}
35+
```
3836

39-
You can also set a default policy to apply to all purgeable statuses by omitting `orchestrationState`:
37+
In this example, the retention policy tells Durable Task Scheduler to keep completed orchestrations for 1 day, and purge the rest.
4038

41-
```json
42-
{
43-
"retentionPeriodInDays": 2
44-
}
45-
```
39+
- **Default policies** are applied to all purgeable statuses by omitting `orchestrationState`:
4640

47-
You can set retention from 0 (purge immediately after completion) to any large number.
41+
```json
42+
{
43+
"retentionPeriodInDays": 2
44+
}
45+
```
4846

49-
[For more information, see the API reference spec for Durable Task Scheduler retention policies](/rest/api/durabletask/retention-policies/create-or-replace?view=rest-durabletask-2025-04-01-preview&preserve-view=true)
47+
[For more information, see the API reference spec for Durable Task Scheduler retention policies.](/rest/api/durabletask/retention-policies/create-or-replace?view=rest-durabletask-2025-04-01-preview&preserve-view=true)
5048

5149
# [Azure CLI](#tab/cli)
5250
todo
@@ -59,7 +57,7 @@ todo
5957
> [!NOTE]
6058
> If both a specific and a default policy are set, the specific policy takes priority.
6159

62-
### Disable autopurge
60+
## Disable autopurge
6361

6462
# [Azure Resource Manager](#tab/arm)
6563

0 commit comments

Comments
 (0)