Skip to content

Commit ad080da

Browse files
committed
split how-to and update TOC
Signed-off-by: Hannah Hunter <[email protected]>
1 parent bbd9ac6 commit ad080da

File tree

5 files changed

+135
-129
lines changed

5 files changed

+135
-129
lines changed

articles/azure-functions/durable/TOC.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,10 @@
3838
- name: Configure Durable Functions app with Durable Task Scheduler
3939
displayName: get started, durable task scheduler
4040
href: ./durable-task-scheduler/quickstart-durable-task-scheduler.md
41-
- name: Configure a container app with Durable Task SDK and Durable Task Scheduler
41+
- name: Create an app with Durable Task SDK and Durable Task Scheduler
42+
displayName: get started, durable task scheduler
43+
href: ./durable-task-scheduler/quickstart-portable-durable-task-sdks.md
44+
- name: Host a Durable Task SDK app on Azure Container Apps
4245
displayName: get started, durable task scheduler
4346
href: ./durable-task-scheduler/quickstart-container-apps-durable-task-sdk.md
4447
- name: Configure Durable Functions app with MSSQL
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
title: Azure Functions Durable Task Scheduler in Durable Functions (preview)
3+
description: Learn how to develop with the Azure Functions Durable Task Scheduler for Durable Functions.
4+
ms.topic: how-to
5+
ms.date: 05/06/2025
6+
---
7+
8+
# Durable Task Scheduler in Durable Functions (preview)
9+
10+
The Azure Functions Durable Task Scheduler is a highly performant, fully managed backend provider for Durable Functions with an [out-of-the-box monitoring dashboard](./durable-task-scheduler-dashboard.md). Azure Functions extensions built into Durable Functions makes building event-driven scenarios easy. In this article, you learn how to:
11+
12+
> [!div class="checklist"]
13+
> * Create a scheduler and task hub.
14+
> * Configure identity-based authentication for your application to access Durable Task Scheduler.
15+
> * Monitor the status of your app and task hub on the Durable Task Scheduler dashboard.
16+
17+
Learn more about Durable Task Scheduler [features](./durable-task-scheduler.md#feature-highlights), [supported regions](./durable-task-scheduler.md#limitations-and-considerations), and [plans](./durable-task-scheduler.md#limitations-and-considerations).
18+
19+
## Create a scheduler and task hub
20+
21+
You can create a scheduler and task hub on Azure portal via two ways:
22+
- **Function app integrated creation:** *(recommended)* automatically creates the managed identity resource and RBAC assignment, plus configures required environment variables for your app to access Durable Task Scheduler.
23+
- **Top-level creation:** Requires you to [manually assign RBAC permission](#configure-identity-based-authentication-for-app-to-access-durable-task-scheduler) to configure scheduler access for your app.
24+
25+
> [!NOTE]
26+
> Durable Task Scheduler currently supports apps hosted in the **App Service** and **Functions Premium** plans, so this experience is available only when either of these plan types is picked.
27+
28+
# [Function app integrated creation](#tab/function-app-integrated-creation)
29+
30+
You can create a scheduler and a task hub as part of the Function app creation on Azure portal.
31+
32+
[!INCLUDE [function-app-integrated-creation](./includes/function-app-integrated-creation.md)]
33+
34+
# [Top-level creation](#tab/top-level-creation)
35+
36+
1. In the Azure portal, search for **Durable Task Scheduler** and select it from the results.
37+
38+
:::image type="content" source="media/create-durable-task-scheduler/search-for-durable-task-scheduler.png" alt-text="Screenshot of searching for the Durable Task Scheduler in the portal.":::
39+
40+
1. Click **Create** to open the **Azure Functions: Durable Task Scheduler (preview)** pane.
41+
42+
:::image type="content" source="media/create-durable-task-scheduler/top-level-create-form.png" alt-text="Screenshot of the create page for the Durable Task Scheduler.":::
43+
44+
1. Fill out the fields in the **Basics** tab. Click **Review + create**. Once the validation passes, click **Create**.
45+
46+
Deployment may take around 15 to 20 minutes.
47+
48+
---
49+
50+
## View all Durable Task Scheduler resources in a subscription
51+
52+
In the Azure portal, search for **Durable Task Scheduler** and select it from the results.
53+
54+
:::image type="content" source="media/create-durable-task-scheduler/search-for-durable-task-scheduler.png" alt-text="Screenshot of searching for the Durable Task Scheduler service in the portal.":::
55+
56+
You can see the list of scheduler resources created in all subscriptions you have access to.
57+
58+
## View all task hubs in a Durable Task Scheduler
59+
60+
You can see all the task hubs created in a scheduler on the **Overview** of the resource on Azure portal.
61+
62+
:::image type="content" source="media/create-durable-task-scheduler/durable-task-scheduler-overview-portal.png" alt-text="Screenshot of overview tab of Durable Task Scheduler in the portal.":::
63+
64+
## Delete the scheduler and task hub
65+
66+
1. Open the scheduler resource on Azure portal and click **Delete**:
67+
68+
:::image type="content" source="media/create-durable-task-scheduler/durable-task-scheduler-delete-portal.png" alt-text="Screenshot of scheduler resource in the portal highlighting delete button.":::
69+
70+
1. Find the scheduler with the task hub you want to delete, then click into that task hub. Click **Delete**:
71+
72+
:::image type="content" source="media/create-durable-task-scheduler/task-hub-delete-portal.png" alt-text="Screenshot of task hub resource in the portal highlighting delete button.":::
73+
74+
## Configure identity-based authentication for app to access Durable Task Scheduler
75+
76+
Durable Task Scheduler **only** supports either *user-assigned* or *system-assigned* managed identity authentication. **User-assigned identities are recommended,** as they aren't tied to the lifecycle of the app and can be reused after the app is deprovisioned.
77+
78+
If you haven't already, [configure managed identity for your Durable Functions app](./durable-task-scheduler-identity.md).
79+
80+
## Access the Durable Task Scheduler dashboard
81+
82+
[Assign the required role to your *developer identity (email)*](./durable-task-scheduler-dashboard.md#access-the-durable-task-scheduler-dashboard) to gain access to the Durable Task Scheduler dashboard.
83+
84+
## Auto scaling in Functions Premium plan
85+
86+
For Durable Functions apps on the Functions Premium plan, you can enable autoscaling using the *Runtime Scale Monitoring* setting.
87+
88+
1. In the portal overview of your function app, navigate to **Settings** > **Configuration**.
89+
90+
1. Under the **Function runtime settings** tab, turn on **Runtime Scale Monitoring**.
91+
92+
:::image type="content" source="media/develop-with-durable-task-scheduler/runtime-scale-monitoring.png" alt-text="Screenshot of searching for Durable Task Scheduler in the portal.":::
93+
94+
You can also set autoscaling using the Azure CLI.
95+
96+
```azurecli
97+
az resource update -g <resource_group> -n <function_app_name>/config/web --set properties.functionsRuntimeScaleMonitoringEnabled=1 --resource-type Microsoft.Web/sites
98+
```
99+
100+
## Limitations
101+
102+
- **Supported hosting plans:**
103+
104+
The Durable Task Scheduler currently only supports Durable Functions running on *Functions Premium* and *App Service* plans. For apps running on the Functions Premium plan, you must [enable the *Runtime Scale Monitoring* setting](./develop-with-durable-task-scheduler.md#auto-scaling-in-functions-premium-plan) to get auto scaling of the app.
105+
106+
The *Consumption*, *Flex Consumption*, and *Azure Container App* hosting plans aren't yet supported when using the Durable Task Scheduler.
107+
108+
- **Migrating [task hub data](../durable-functions-task-hubs.md) across backend providers:**
109+
110+
Currently, migrating across providers isn't supported. Function apps that have existing runtime data need to start with a fresh, empty task hub after they switch to the Durable Task Scheduler. Similarly, the task hub contents that are created by using the scheduler resource can't be preserved if you switch to a different backend provider.
111+
112+
## Next steps
113+
114+
> [!div class="nextstepaction"]
115+
> [Run and deploy your Durable Functions app using the Durable Task Scheduler](./quickstart-durable-task-scheduler.md)

articles/azure-functions/durable/durable-task-scheduler/develop-with-durable-task-scheduler.md

Lines changed: 14 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
2-
title: Develop with the Azure Functions Durable Task Scheduler (preview)
3-
description: Learn how to develop with the Azure Functions Durable Task Scheduler and task hub resources.
2+
title: Develop with Durable Task Scheduler (preview)
3+
description: Learn how to develop with the Durable Task Scheduler using the Azure CLI for both Durable Functions and Durable Task Scheduler.
44
ms.topic: how-to
55
ms.date: 05/06/2025
6-
zone_pivot_groups: dts-devexp
76
---
87

9-
# Develop with the Azure Functions Durable Task Scheduler (preview)
8+
# Develop with Durable Task Scheduler (preview)
109

11-
The Azure Functions Durable Task Scheduler is a highly performant, fully managed backend provider for Durable Functions with an [out-of-the-box monitoring dashboard](./durable-task-scheduler-dashboard.md). In this article, you learn how to:
10+
The Durable Task Scheduler is a highly performant, fully managed backend provider for Durable Functions with an [out-of-the-box monitoring dashboard](./durable-task-scheduler-dashboard.md). Azure offers two developer-oriented orchestration frameworks that work with Durable Functions to build apps: Durable Task SDKs and Durable Functions.
11+
12+
In this article, you use the Azure CLI and the Durable Task extension to:
1213

1314
> [!div class="checklist"]
1415
> * Create a scheduler and task hub.
@@ -17,7 +18,8 @@ The Azure Functions Durable Task Scheduler is a highly performant, fully managed
1718
1819
Learn more about Durable Task Scheduler [features](./durable-task-scheduler.md#feature-highlights), [supported regions](./durable-task-scheduler.md#limitations-and-considerations), and [plans](./durable-task-scheduler.md#limitations-and-considerations).
1920

20-
::: zone pivot="az-cli"
21+
> [!NOTE]
22+
> Durable Task Scheduler currently supports apps hosted in the **App Service** and **Functions Premium** plans only.
2123
2224
## Prerequisites
2325

@@ -44,8 +46,6 @@ Learn more about Durable Task Scheduler [features](./durable-task-scheduler.md#f
4446
az extension add --upgrade --name durabletask
4547
```
4648
47-
::: zone-end
48-
4949
## Run the Durable Task emulator
5050
5151
1. Pull the docker image containing the emulator.
@@ -68,11 +68,6 @@ Learn more about Durable Task Scheduler [features](./durable-task-scheduler.md#f
6868

6969
## Create a scheduler and task hub
7070

71-
::: zone pivot="az-cli"
72-
73-
> [!NOTE]
74-
> Durable Task Scheduler currently supports apps hosted in the **App Service** and **Functions Premium** plans only.
75-
7671
1. Create a resource group.
7772

7873
```azurecli
@@ -147,45 +142,8 @@ Learn more about Durable Task Scheduler [features](./durable-task-scheduler.md#f
147142
}
148143
```
149144

150-
::: zone-end
151-
152-
::: zone pivot="az-portal"
153-
154-
You can create a scheduler and task hub on Azure portal via two ways:
155-
- **Function app integrated creation:** *(recommended)* automatically creates the managed identity resource and RBAC assignment, plus configures required environment variables for your app to access Durable Task Scheduler.
156-
- **Top-level creation:** Requires you to [manually assign RBAC permission](#configure-identity-based-authentication-for-app-to-access-durable-task-scheduler) to configure scheduler access for your app.
157-
158-
> [!NOTE]
159-
> Durable Task Scheduler currently supports apps hosted in the **App Service** and **Functions Premium** plans, so this experience is available only when either of these plan types is picked.
160-
161-
# [Function app integrated creation](#tab/function-app-integrated-creation)
162-
163-
You can create a scheduler and a task hub as part of the Function app creation on Azure portal.
164-
165-
[!INCLUDE [function-app-integrated-creation](./includes/function-app-integrated-creation.md)]
166-
167-
# [Top-level creation](#tab/top-level-creation)
168-
169-
1. In the Azure portal, search for **Durable Task Scheduler** and select it from the results.
170-
171-
:::image type="content" source="media/create-durable-task-scheduler/search-for-durable-task-scheduler.png" alt-text="Screenshot of searching for the Durable Task Scheduler in the portal.":::
172-
173-
1. Click **Create** to open the **Azure Functions: Durable Task Scheduler (preview)** pane.
174-
175-
:::image type="content" source="media/create-durable-task-scheduler/top-level-create-form.png" alt-text="Screenshot of the create page for the Durable Task Scheduler.":::
176-
177-
1. Fill out the fields in the **Basics** tab. Click **Review + create**. Once the validation passes, click **Create**.
178-
179-
Deployment may take around 15 to 20 minutes.
180-
181-
---
182-
183-
::: zone-end
184-
185145
## View all Durable Task Scheduler resources in a subscription
186146

187-
::: zone pivot="az-cli"
188-
189147
1. Get a list of all scheduler names within a subscription by running the following command.
190148

191149
```azurecli
@@ -198,42 +156,16 @@ You can create a scheduler and a task hub as part of the Function app creation o
198156
az durabletask scheduler list --subscription <SUBSCRIPTION_ID> --resource-group <RESOURCE_GROUP_NAME>
199157
```
200158

201-
::: zone-end
202-
203-
::: zone pivot="az-portal"
204-
205-
In the Azure portal, search for **Durable Task Scheduler** and select it from the results.
206-
207-
:::image type="content" source="media/create-durable-task-scheduler/search-for-durable-task-scheduler.png" alt-text="Screenshot of searching for the Durable Task Scheduler service in the portal.":::
208-
209-
You can see the list of scheduler resources created in all subscriptions you have access to.
210-
211-
::: zone-end
212-
213159
## View all task hubs in a Durable Task Scheduler
214160

215-
::: zone pivot="az-cli"
216-
217161
Retrieve a list of task hubs in a specific scheduler by running:
218162

219163
```azurecli
220164
az durabletask taskhub list --resource-group <RESOURCE_GROUP_NAME> --scheduler-name <SCHEDULER_NAME>
221165
```
222166

223-
::: zone-end
224-
225-
::: zone pivot="az-portal"
226-
227-
You can see all the task hubs created in a scheduler on the **Overview** of the resource on Azure portal.
228-
229-
:::image type="content" source="media/create-durable-task-scheduler/durable-task-scheduler-overview-portal.png" alt-text="Screenshot of overview tab of Durable Task Scheduler in the portal.":::
230-
231-
::: zone-end
232-
233167
## Delete the scheduler and task hub
234168

235-
::: zone pivot="az-cli"
236-
237169
1. Delete the scheduler:
238170

239171
```azurecli
@@ -246,20 +178,6 @@ You can see all the task hubs created in a scheduler on the **Overview** of the
246178
az durabletask taskhub delete --resource-group YOUR_RESOURCE_GROUP --scheduler-name YOUR_SCHEDULER --name YOUR_TASKHUB
247179
```
248180

249-
::: zone-end
250-
251-
::: zone pivot="az-portal"
252-
253-
1. Open the scheduler resource on Azure portal and click **Delete**:
254-
255-
:::image type="content" source="media/create-durable-task-scheduler/durable-task-scheduler-delete-portal.png" alt-text="Screenshot of scheduler resource in the portal highlighting delete button.":::
256-
257-
1. Find the scheduler with the task hub you want to delete, then click into that task hub. Click **Delete**:
258-
259-
:::image type="content" source="media/create-durable-task-scheduler/task-hub-delete-portal.png" alt-text="Screenshot of task hub resource in the portal highlighting delete button.":::
260-
261-
::: zone-end
262-
263181
## Configure identity-based authentication for app to access Durable Task Scheduler
264182

265183
Durable Task Scheduler **only** supports either *user-assigned* or *system-assigned* managed identity authentication. **User-assigned identities are recommended,** as they aren't tied to the lifecycle of the app and can be reused after the app is deprovisioned.
@@ -270,29 +188,11 @@ If you haven't already, [configure managed identity for your Durable Functions a
270188

271189
[Assign the required role to your *developer identity (email)*](./durable-task-scheduler-dashboard.md#access-the-durable-task-scheduler-dashboard) to gain access to the Durable Task Scheduler dashboard.
272190

273-
## Auto scaling in Functions Premium plan
274-
275-
For Durable Functions apps on the Functions Premium plan, you can enable autoscaling using the *Runtime Scale Monitoring* setting.
276-
277-
::: zone pivot="az-portal"
278-
279-
1. In the portal overview of your function app, navigate to **Settings** > **Configuration**.
280-
281-
1. Under the **Function runtime settings** tab, turn on **Runtime Scale Monitoring**.
282-
283-
:::image type="content" source="media/develop-with-durable-task-scheduler/runtime-scale-monitoring.png" alt-text="Screenshot of searching for Durable Task Scheduler in the portal.":::
284-
285-
::: zone-end
286-
287-
::: zone pivot="az-cli"
288-
289-
```azurecli
290-
az resource update -g <resource_group> -n <function_app_name>/config/web --set properties.functionsRuntimeScaleMonitoringEnabled=1 --resource-type Microsoft.Web/sites
291-
```
292-
293-
::: zone-end
294-
295191
## Next steps
296192

297-
> [!div class="nextstepaction"]
298-
> [Run and deploy your Durable Functions app using the Durable Task Scheduler](./quickstart-durable-task-scheduler.md)
193+
For Durable Task Scheduler for Durable Functions:
194+
- [Quickstart: Configure a Durable Functions app to use Azure Functions Durable Task Scheduler](./quickstart-durable-task-scheduler.md)
195+
196+
For Durable Task Scheduler for the Durable Task SDKs:
197+
- [Quickstart: Create an app with Durable Task SDKs and Durable Task Scheduler](./quickstart-portable-durable-task-sdks.md)
198+
- [Quickstart: Host a Durable Task SDK app on Azure Container Apps](./quickstart-container-apps-durable-task-sdk.md)

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

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,6 @@ Large volumes of completed orchestration instance data can lead to storage bloat
161161
> [!NOTE]
162162
> Feature availability is subject to change as the Durable Task Scheduler backend approaches general availability. To report problems or request new features, submit an issue in the [Durable Task Scheduler samples GitHub repository](https://github.com/Azure-Samples/Durable-Task-Scheduler/).
163163

164-
### Specific to Durable Task Scheduler for Durable Functions
165-
166-
- **Supported hosting plans:**
167-
168-
The Durable Task Scheduler currently only supports Durable Functions running on *Functions Premium* and *App Service* plans. For apps running on the Functions Premium plan, you must [enable the *Runtime Scale Monitoring* setting](./develop-with-durable-task-scheduler.md#auto-scaling-in-functions-premium-plan) to get auto scaling of the app.
169-
170-
The *Consumption*, *Flex Consumption*, and *Azure Container App* hosting plans aren't yet supported when using the Durable Task Scheduler.
171-
172-
- **Migrating [task hub data](../durable-functions-task-hubs.md) across backend providers:**
173-
174-
Currently, migrating across providers isn't supported. Function apps that have existing runtime data need to start with a fresh, empty task hub after they switch to the Durable Task Scheduler. Similarly, the task hub contents that are created by using the scheduler resource can't be preserved if you switch to a different backend provider.
175-
176164
## Next steps
177165

178166
> [!div class="nextstepaction"]

articles/azure-functions/durable/durable-task-scheduler/quickstart-container-apps-durable-task-sdk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: "Quickstart: Configure the Durable Task SDKs in your container app with Durable Task Scheduler (preview)"
2+
title: "Quickstart: Host a Durable Task SDK app on Azure Container Apps (preview)"
33
description: Learn how to configure an existing container app for the Durable Task Scheduler using the Durable Task SDKs and deploy using Azure Developer CLI.
44
ms.subservice: durable-task-scheduler
55
ms.topic: quickstart
66
ms.date: 05/06/2025
77
zone_pivot_groups: df-languages
88
---
99

10-
# Quickstart: Configure Durable Task SDKs in your container app with Durable Task Scheduler (preview)
10+
# Quickstart: Host a Durable Task SDK app on Azure Container Apps (preview)
1111

1212
::: zone pivot="javascript"
1313

0 commit comments

Comments
 (0)