Develop with Durable Task Scheduler

Prerequisites

• The latest version of the Azure CLI.

Set up the CLI

1. Sign in to Azure and ensure you have the latest CLI version.

   az login
   az upgrade
   

2. Install the Durable Task Scheduler CLI extension.

   az extension add --name durabletask
   

3. If you already installed the Durable Task Scheduler CLI extension, upgrade to the latest version.

   az extension update --name durabletask
   

4. Check your installed version:

   az extension show --name durabletask
   

Learn more about the az durabletask commands.

1. Create a resource group.

   az group create --name YOUR_RESOURCE_GROUP --location LOCATION
   

2. Using the durabletask CLI extension, create a scheduler.

   • Dedicated SKU
   • Consumption SKU

   az durabletask scheduler create --name "YOUR_SCHEDULER" --resource-group "YOUR_RESOURCE_GROUP" --location "LOCATION" --ip-allowlist "[0.0.0.0/0]" --sku-name "dedicated" --sku-capacity "1"
   

   The creation process may take up to 15 minutes to complete.

   Output

   {
       "id": "/subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/YOUR_RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/YOUR_SCHEDULER",
       "location": "northcentralus",
       "name": "YOUR_SCHEDULER",
       "properties": {
           "endpoint": "https://YOUR_SCHEDULER.northcentralus.durabletask.io",
           "ipAllowlist": [
               "0.0.0.0/0"
           ],
           "provisioningState": "Succeeded",
           "sku": {
               "capacity": 1,
               "name": "Dedicated",
               "redundancyState": "None"
           }
       },
       "resourceGroup": "YOUR_RESOURCE_GROUP",
       "systemData": {
           "createdAt": "2025-01-06T21:22:59Z",
           "createdBy": "YOUR_EMAIL@example.com",
           "createdByType": "User",
           "lastModifiedAt": "2025-01-06T21:22:59Z",
           "lastModifiedBy": "YOUR_EMAIL@example.com",
           "lastModifiedByType": "User"
       },
       "tags": {}
   }
   

3. Create a task hub.

   az durabletask taskhub create --resource-group YOUR_RESOURCE_GROUP --scheduler-name YOUR_SCHEDULER --name YOUR_TASKHUB
   

   Output

   {
     "id": "/subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/YOUR_RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/YOUR_SCHEDULERS/taskHubs/YOUR_TASKHUB",
     "name": "YOUR_TASKHUB",
     "properties": {
       "provisioningState": "Succeeded"
     },
     "resourceGroup": "YOUR_RESOURCE_GROUP",
     "systemData": {
       "createdAt": "2024-09-18T22:13:56.5467094Z",
       "createdBy": "OBJECT_ID",
       "createdByType": "User",
       "lastModifiedAt": "2024-09-18T22:13:56.5467094Z",
       "lastModifiedBy": "OBJECT_ID",
       "lastModifiedByType": "User"
     },
     "type": "microsoft.durabletask/scheduler/taskhubs"
   }
   

1. In the Azure portal, search for Durable Task Scheduler and select it from the results.

   

2. Select Create to open the Durable Task Scheduler pane.

   

3. Fill out the fields in the Basics tab. Select Review + create.

4. Once the validation passes, select Create.

   Deployment may take around 15 to 20 minutes.

1. Get a list of all scheduler names within a subscription by running the following command.

   az durabletask scheduler list --subscription <SUBSCRIPTION_ID>
   

2. You can narrow down results to a specific resource group by adding the --resource-group flag.

   az durabletask scheduler list --subscription <SUBSCRIPTION_ID> --resource-group <RESOURCE_GROUP_NAME>
   

In the Azure portal, search for Durable Task Scheduler and select it from the results.

You can see the list of scheduler resources created in all subscriptions you have access to.

Retrieve a list of task hubs in a specific scheduler by running:

az durabletask taskhub list --resource-group <RESOURCE_GROUP_NAME> --scheduler-name <SCHEDULER_NAME>

You can see all the task hubs created in a scheduler on the Overview of the resource on Azure portal.

1. Delete the task hub first:

   az durabletask taskhub delete --resource-group YOUR_RESOURCE_GROUP --scheduler-name YOUR_SCHEDULER --name YOUR_TASKHUB
   

2. Delete the scheduler:

   az durabletask scheduler delete --resource-group YOUR_RESOURCE_GROUP --scheduler-name YOUR_SCHEDULER
   

1. Open the scheduler resource in the Azure portal and select Delete:

   

2. Find the scheduler with the task hub you want to delete, then select that task hub. Select Delete: