|
1 | 1 | ---
|
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 |
6 | 7 | ---
|
7 | 8 |
|
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) |
9 | 10 |
|
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 |
15 | 105 |
|
16 | 106 | ## Monitor orchestration progress and execution history
|
17 | 107 |
|
@@ -51,10 +141,12 @@ The dashboard includes features for managing orchestrations on demand, such as s
|
51 | 141 |
|
52 | 142 | :::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.":::
|
53 | 143 |
|
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 |
| - |
58 | 144 | ## Next steps
|
59 | 145 |
|
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) |
0 commit comments