You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-functions/durable/durable-task-scheduler/durable-task-scheduler-auto-purge.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,17 +13,19 @@ Autopurge operates asynchronously in the background, optimized to minimize syste
13
13
14
14
## How it works
15
15
16
-
Autopurge is an opt-in feature. You can enable it by defining retention policies that control how long to keep the data of orchestrations in certain statuses. The autopurge feature purges orchestration data associated only with the following statuses:
16
+
Autopurge is an opt-in feature. You can enable it by defining retention policies that control how long to keep the data of orchestrations in certain statuses. The autopurge feature purges orchestration data associated with terminal statuses. "Terminal" refers to an orchestration state that no longer results in triggering work items. Terminal statuses include:
17
17
-`Completed`
18
18
-`Failed`
19
19
-`Canceled`
20
20
-`Terminated`
21
21
22
-
Autopurge ignores orchestration data associated with the following statuses:
22
+
Autopurge ignores orchestration data associated with non-terminal statuses. "Non-terminal" refers to an orchestration that is running, paused, or waiting for a worker. These statuses include:
23
23
-`Pending`
24
24
-`Running`
25
+
-`Suspended`
26
+
-`Continued_As_New`
25
27
26
-
[Once enabled,](#enable-autopurge) autopurge periodically deletes orchestration data older than the retention period you set.
28
+
[Once enabled,](#enable-autopurge) autopurge periodically deletes orchestration data older than the retention period you set. Autopurge only
27
29
28
30
> [!NOTE]
29
31
> Retention policies you define are applied to **all** task hubs in a scheduler.
@@ -32,6 +34,8 @@ Autopurge ignores orchestration data associated with the following statuses:
32
34
33
35
Retention value can range from 0 (purge as soon as possible) to the maximum integer value, with the unit being **days**.
34
36
37
+
The retention period refers to the time period since the orchestration entered terminal state. For example, you set a retention value of 1 day. If the orchestration takes 10 days to finish, autopurge won't delete it until the following day. Autopurge isn't triggered until the orchestration finishes.
38
+
35
39
Although retention periods have no maximum limit, we recommend you avoid retaining large volumes of stale orchestration data for extended periods. This practice ensures efficient use of storage resources and maintains optimal app performance.
36
40
37
41
### Types of policies
@@ -149,7 +153,8 @@ If creation is successful, you receive the following response.
149
153
}
150
154
```
151
155
152
-
Learn more about the retention policy `create` command by running `az durabletask retention-policy create --help`.
156
+
> [!TIP]
157
+
> Learn more about the retention policy command via [the CLI reference][TODO].
0 commit comments