Quickstart: Configure a Durable Functions app to use Durable Task Scheduler

Use the Durable Task Scheduler as a backend for your Durable Functions apps to store orchestration and entity runtime state. In this quickstart, you clone a Hello Cities sample that's already configured to use the Durable Task Scheduler, run it locally with the emulator, and then deploy it to Azure.

Prerequisites

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.DurableTask.AzureManaged --prerelease

{
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[4.32.0, 5.0.0)"
  }
}

{
  "extensions": {
    "durableTask": {
      "hubName": "default",
      "storageProvider": {
        "type": "azureManaged",
        "connectionStringName": "DURABLE_TASK_SCHEDULER_CONNECTION_STRING"
      }
    }
  }
}

{
  "Values": {
    "DURABLE_TASK_SCHEDULER_CONNECTION_STRING": "Endpoint=http://localhost:8080;TaskHub=default;Authentication=None"
  }
}

Run your app in Azure

Create required resources

Create a Durable Task Scheduler instance and Azure Functions app on Azure following the Function app integrated creation flow. This experience will automatically set up identity-based access and configure the required environment variables for the app to access the scheduler.

1. Navigate to the Function app creation blade.

   

2. In the Create Function App (Flex Consumption) blade, fill in the information in the Basics tab.

   

   Field	Description
   Subscription	Select your Azure subscription.
   Resource Group	Select an existing resource group or click Create new to create a new one.
   Function App name	Create a unique name for your function app.
   Do you want to deploy code or container image?	Keep the Code option selected.
   Region	Select one of the supported regions.
   Runtime stack	Select the runtime you're using for this quickstart.
   Version	Select your runtime stack version.
   Instance size	Select an instance size, or use the default selection. Learn more about instance sizes.
   Zone Redundancy	Leave as the default Disabled setting.

3. Select the Durable Functions tab.

4. Choose Azure managed: Durable Task Scheduler as the backend provider for your Durable Functions.

5. Create a scheduler resource. This action automatically creates a task hub.

   

   Field	Description
   Storage backend	Select Azure managed: Durable Task Scheduler.
   Region	Make sure the scheduler and function app regions are the same.
   Durable Task Scheduler	Use the scheduler name offered, or click Create new to create a custom name.
   Plan	Select the pricing plan that fits your project best. Check the Choosing an orchestration framework guide to determine which plan is best for production use.
   Capacity units	Only applicable when "Dedicated" pricing plan is selected. You can select up to 3 Capacity Units.

6. Click Review + create to review the resource creation.

   A user-assigned managed identity with the required role-based access control (RBAC) permission is created automatically and added to the Function app. You can find in the summary view information related to the managed identity resource, such as:

   • The role assigned to it (Durable Task Data Contributor)

   • The assignment scoped to the task hub level

     

7. Click Create once validation passes.

Resource deployment could take around 15 to 20 minutes. Once that is finished, you can deploy your app to Azure.

Deploy your function app to Azure

1. In the command palette, enter and then select Azure Functions: Deploy to Function App.

2. Select the function app you just created. When prompted about overwriting previous deployments, select Deploy to deploy your function code to the new function app resource.

3. When deployment is completed, select View Output to view the creation and deployment results, including the Azure resources that you created. If you miss the notification, select the bell icon in the lower-right corner to see it again.

   

Apps on Functions Premium plan

If your app is running on the Functions Premium plan, turn on the Runtime Scale Monitoring setting after deployment to ensure your app autoscales based on load:

az resource update -g <resource_group> -n <function_app_name>/config/web --set properties.functionsRuntimeScaleMonitoringEnabled=1 --resource-type Microsoft.Web/sites

Test your function app

Run the following command to get your function's URL:

az functionapp function list --resource-group <RESOURCE_GROUP_NAME> --name <FUNCTION_APP_NAME>  --query '[].{Function:name, URL:invokeUrlTemplate}' --output json

Check orchestration status

Check the status of the orchestration instance and activity details on the Durable Task Scheduler dashboard. Accessing the dashboard requires you to log in.

1. Navigate to the Durable Task Scheduler resource on the portal.

2. Click on a task hub name.

3. In the left menu, select Access control (IAM).

4. Click Add to add a role assignment.

   

5. Search for and select Durable Task Data Contributor. Click Next.

   

6. On the Members tab, for Assign access to, select User, group, or service principal.

7. For Members, click + Select members.

8. In the Select members pane, search for your name or email:

   

9. Pick your email and click the Select button.

10. Click Review + assign to finish assigning the role.

11. Once the role is assigned, click Overview on the left menu of the task hub resource and navigate to the dashboard URL located at the top Essentials section.

Clean up resources

If you no longer need the resources that you created to complete the quickstart, to avoid related costs in your Azure subscription, delete the resource group and all related resources.

Next steps

• Learn more about the Durable Task Scheduler dashboard.
• Troubleshoot any errors you may encounter while using Durable Task Scheduler.