Skip to content

Commit 89e27a1

Browse files
authored
Merge pull request #299376 from hhunter-ms/copyedit
Copyedit for all DTS docs
2 parents b51c249 + b4133bb commit 89e27a1

12 files changed

+476
-390
lines changed

articles/azure-functions/durable/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,8 @@
116116
href: ./durable-task-scheduler/choose-orchestration-framework.md
117117
- name: Concepts
118118
items:
119+
- name: Identity
120+
href: ./durable-task-scheduler/durable-task-scheduler-identity.md
119121
- name: Monitoring dashboard
120122
href: ./durable-task-scheduler/durable-task-scheduler-dashboard.md
121123
- name: Auto-purge

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

Lines changed: 34 additions & 265 deletions
Large diffs are not rendered by default.

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

Lines changed: 107 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,107 @@
11
---
2-
title: Debug and manage orchestrations using the Azure Functions durable task scheduler dashboard (preview)
3-
description: Learn how to debug and manage your orchestrations using the Azure Functions durable task scheduler.
4-
ms.topic: conceptual
5-
ms.date: 03/17/2025
2+
title: Debug and manage orchestrations using the Azure Functions Durable Task Scheduler dashboard (preview)
3+
description: Learn how to debug and manage your orchestrations using the Azure Functions Durable Task Scheduler.
4+
ms.topic: how-to
5+
ms.date: 05/05/2025
6+
zone_pivot_groups: dts-devexp
67
---
78

8-
# Debug and manage orchestrations using the Azure Functions durable task scheduler dashboard (preview)
9+
# Debug and manage orchestrations using the Azure Functions Durable Task Scheduler dashboard (preview)
910

10-
Observe, manage, and debug your task hub or scheduler's orchestrations effectively using the durable task scheduler dashboard. The dashboard is available when you run the [durable task scheduler emulator](./durable-task-scheduler.md#emulator-for-local-development) locally or create a scheduler resource on Azure.
11-
- **Running locally** doesn't require authentication.
12-
- **Creating a scheduler resource on Azure** requires that you [assign the *Durable Task Data Contributor* role to your identity](./develop-with-durable-task-scheduler.md#accessing-durable-task-scheduler-dashboard). You can then access the dashboard via either:
13-
- The task hub's dashboard endpoint URL in the Azure portal
14-
- Navigate to `https://dashboard.durabletask.io/` combined with your task hub endpoint.
11+
Observe, manage, and debug your task hub or scheduler's orchestrations using the Durable Task Scheduler dashboard. The dashboard is available when you run the [Durable Task Scheduler emulator](./durable-task-scheduler.md#emulator-for-local-development) locally or create a scheduler resource on Azure.
12+
13+
Running the emulator locally doesn't require authentication.
14+
15+
Creating a scheduler resource on Azure requires [assigning the *Durable Task Data Contributor* role to your identity](./durable-task-scheduler-identity.md). You can then access the dashboard via either:
16+
- The task hub's dashboard endpoint URL in the Azure portal
17+
- Navigate to `https://dashboard.durabletask.io/` combined with your task hub endpoint.
18+
19+
In this article, you learn how to:
20+
21+
> [!div class="checklist"]
22+
>
23+
> - Assign one of the Durable Task roles to your developer identity.
24+
> - Access the Durable Task Scheduler dashboard.
25+
> - View orchestration status and history via the Durable Task Scheduler dashboard.
26+
27+
## Prerequisites
28+
29+
Before you begin:
30+
31+
- [Install the latest Azure CLI](/cli/azure/install-azure-cli)
32+
- [Create a scheduler and task hub resource](./develop-with-durable-task-scheduler.md)
33+
- [Configure managed identity for your Durable Task Scheduler resource](./durable-task-scheduler-identity.md)
34+
35+
## Access the Durable Task Scheduler dashboard
36+
37+
Assign the required role to your *developer identity (email)* to gain access to the [Durable Task Scheduler dashboard](./durable-task-scheduler-dashboard.md).
38+
39+
::: zone pivot="az-cli"
40+
41+
1. Set the assignee to your developer identity.
42+
43+
```azurecli
44+
assignee=$(az ad user show --id "[email protected]" --query "id" --output tsv)
45+
```
46+
47+
1. Set the scope. Granting access on the scheduler scope gives access to *all* task hubs in that scheduler.
48+
49+
**Task Hub**
50+
51+
```bash
52+
scope="/subscriptions/SUBSCRIPTION_ID/resourceGroups/RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/SCHEDULER_NAME/taskHubs/TASK_HUB_NAME"
53+
```
54+
55+
**Scheduler**
56+
```bash
57+
scope="/subscriptions/SUBSCRIPTION_ID/resourceGroups/RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/SCHEDULER_NAME"
58+
```
59+
60+
1. Grant access. Run the following command to create the role assignment and grant access.
61+
62+
```azurecli
63+
az role assignment create \
64+
--assignee "$assignee" \
65+
--role "Durable Task Data Contributor" \
66+
--scope "$scope"
67+
```
68+
69+
*Expected output*
70+
71+
The following output example shows a developer identity assigned with the Durable Task Data Contributor role on the *scheduler* level:
72+
73+
```json
74+
{
75+
"condition": null,
76+
"conditionVersion": null,
77+
"createdBy": "YOUR_DEVELOPER_CREDENTIAL_ID",
78+
"createdOn": "2024-12-20T01:36:45.022356+00:00",
79+
"delegatedManagedIdentityResourceId": null,
80+
"description": null,
81+
"id": "/subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/YOUR_RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/YOUR_DTS_NAME/providers/Microsoft.Authorization/roleAssignments/ROLE_ASSIGNMENT_ID",
82+
"name": "ROLE_ASSIGNMENT_ID",
83+
"principalId": "YOUR_DEVELOPER_CREDENTIAL_ID",
84+
"principalName": "YOUR_EMAIL",
85+
"principalType": "User",
86+
"resourceGroup": "YOUR_RESOURCE_GROUP",
87+
"roleDefinitionId": "/subscriptions/YOUR_SUBSCRIPTION/providers/Microsoft.Authorization/roleDefinitions/ROLE_DEFINITION_ID",
88+
"roleDefinitionName": "Durable Task Data Contributor",
89+
"scope": "/subscriptions/YOUR_SUBSCRIPTION/resourceGroups/YOUR_RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/YOUR_DTS_NAME",
90+
"type": "Microsoft.Authorization/roleAssignments",
91+
"updatedBy": "YOUR_DEVELOPER_CREDENTIAL_ID",
92+
"updatedOn": "2024-12-20T01:36:45.022356+00:00"
93+
}
94+
```
95+
96+
1. After granting access, go to `https://dashboard.durabletask.io/` and fill out the required information about your scheduler and task hub to see the dashboard.
97+
98+
::: zone-end
99+
100+
::: zone pivot="az-portal"
101+
102+
[!INCLUDE [assign-dev-identity-role-based-access-control-portal](./includes/assign-dev-identity-role-based-access-control-portal.md)]
103+
104+
::: zone-end
15105
16106
## Monitor orchestration progress and execution history
17107
@@ -51,10 +141,12 @@ The dashboard includes features for managing orchestrations on demand, such as s
51141
52142
:::image type="content" source="media/durable-task-scheduler-dashboard/manage-orchestration.png" alt-text="Screenshot of the dashboard showing the buttons you use to manage the orchestration.":::
53143
54-
## Security
55-
56-
Dashboard access is secured through [integration with Azure Role-Based Access Control (RBAC)](./develop-with-durable-task-scheduler.md#accessing-durable-task-scheduler-dashboard).
57-
58144
## Next steps
59145
60-
[Try out the quickstart to see the durable task scheduler dashboard in action](./quickstart-durable-task-scheduler.md)
146+
For Durable Task Scheduler for Durable Functions:
147+
- [Quickstart: Configure a Durable Functions app to use the Durable Task Scheduler](./quickstart-durable-task-scheduler.md)
148+
- [Create Durable Task Scheduler resources and view them in the dashboard](./develop-with-durable-task-scheduler.md)
149+
150+
For Durable Task Scheduler for the Durable Task SDKs:
151+
- [Quickstart: Create an app with Durable Task SDKs and Durable Task Scheduler](./quickstart-portable-durable-task-sdks.md)
152+
- [Quickstart: Configure Durable Task SDKs in your container app](./quickstart-container-apps-durable-task-sdk.md)

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
2-
title: Use the Dedicated SKU for Azure Functions durable task scheduler (preview)
3-
description: Learn about how the Dedicated SKU in Azure Functions durable task scheduler.
2+
title: Use the Dedicated SKU for Azure Functions Durable Task Scheduler (preview)
3+
description: Learn about how the Dedicated SKU in Azure Functions Durable Task Scheduler.
44
ms.topic: conceptual
55
ms.date: 03/17/2025
66
---
77

8-
# Use the Dedicated SKU for Azure Functions durable task scheduler (preview)
8+
# Use the Dedicated SKU for Azure Functions Durable Task Scheduler (preview)
99

10-
Durable task scheduler currently offers the Dedicated SKU only. In this article, you'll learn:
10+
Durable Task Scheduler currently offers the Dedicated SKU only. In this article, you'll learn:
1111
- What the Dedicated SKU provides
1212
- How you're billed
1313
- Relevant concepts such as *capacity unit* and *work item*
1414

1515
## Dedicated SKU concepts
1616

17-
You're billed based on the number of "Capacity Units (CUs)" purchased. In the durable task scheduler context:
17+
You're billed based on the number of "Capacity Units (CUs)" purchased. In the Durable Task Scheduler context:
1818

1919
- **A Capacity Unit (CU)** is a measure of the resources allocated to your scheduler resource. Each CU represents a preallocated amount of CPU, memory, and storage resources. A single CU guarantees the dispatch of a number of *work items* and provides a defined amount of storage. If extra performance and/or storage is needed, more CUs can be purchased.
20-
- **Work item** is a message dispatched by the durable task scheduler to an application, triggering the execution of orchestrator, activity, or entity functions. The number of work items that can be dispatched per second is determined by the CUs allocated to the scheduler.
20+
- **Work item** is a message dispatched by the Durable Task Scheduler to an application, triggering the execution of orchestrator, activity, or entity functions. The number of work items that can be dispatched per second is determined by the CUs allocated to the scheduler.
2121

2222
The following table explains the minimum cost and features provided with each CU.
2323

@@ -32,14 +32,14 @@ Find the price of a capacity unit in a given region on the [Azure Functions pric
3232
## Determine the number of Capacity Units needed
3333

3434
> [!NOTE]
35-
> Durable task scheduler supports purchasing only **one capacity unit** at the moment.
35+
> Durable Task Scheduler supports purchasing only **one capacity unit** at the moment.
3636
3737
To determine whether one unit is sufficient for your workload, follow these steps:
3838

3939
1. **Understand how to identify the number of work items per orchestration**
4040
- Starting an orchestration consumes a single work item.
4141
- Each schedule of an activity run consumes another work item.
42-
- Each response sent back to the durable task scheduler consumes another work item.
42+
- Each response sent back to the Durable Task Scheduler consumes another work item.
4343

4444
1. **Estimate monthly orchestrations**
4545
Calculate the total number of orchestrations you need to run per month.
@@ -57,4 +57,4 @@ For example, if you run 100 million orchestrations per month and each orchestrat
5757

5858
## Next steps
5959

60-
Try out the [durable functions quickstart sample](quickstart-durable-task-scheduler.md).
60+
Try out the [Durable Functions quickstart sample](quickstart-durable-task-scheduler.md).

0 commit comments

Comments
 (0)