Azure-Samples · lilyjma · Mar 19, 2025 · Mar 17, 2025 · Mar 18, 2025 · Mar 18, 2025
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@
 *.user
 *.userosscache
 *.sln.docstates
+**/.DS_Store
 
 # User-specific files (MonoDevelop/Xamarin Studio)
 *.userprefs

diff --git a/README.md b/README.md
@@ -1,57 +1,43 @@
-# Project Name
+## Azure Functions durable task scheduler
 
-(short, 1-3 sentenced, description of the project)
+The durable task scheduler is a solution for durable execution in Azure. Durable execution is a fault-tolerant approach to running code that handles failures and interruptions through automatic retries and state persistence. Scenarios where durable execution is required include distributed transactions, multi-agent orchestration, data processing, infrastructure management, and others. Coupled with a developer orchestration framework like Durable Functions or the Durable Task SDKs, the durable task scheduler enables developers to author stateful apps that run on any compute environment without the need to architect for fault tolerance. 
 
-## Features
+Developers can use the durable task scheduler with the following orchestration frameworks: 
+- [Durable Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview) 
+- Durable Task SDKs, also referred to as "portable SDKs"
+- [Durable Task Framework](https://github.com/Azure/durabletask) 
 
-This project framework provides the following features:
+### Use with Durable Functions and Durable Task Framework
+When used with Durable Functions, a feature of Azure Functions, the durable task scheduler plays the role the ["backend provider"](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-storage-providers), where state data is persisted as the app runs. While other backend providers are supported, only the durable task scheduler offers a fully managed experience, which removes operational overhead from users. Additionally, the scheduler offers exceptional performance, reliability, and the ease of monitoring orchestrations. 
 
-* Feature 1
-* Feature 2
-* ...
+The durable task scheduler plays a similar role in the Durable Task Framework as in Durable Functions. 
 
-## Getting Started
+### Use with Durable Task SDKs or "portable SDKs"
+The Durable Task SDKs provide a lightweight client library for the durable task scheduler. When running orchestrations, apps using these SDKs would make a connection to the scheduler's orchestration engine in Azure. These SDKs are called "portable" because apps that leverage them can be hosted in various compute environments, such as Azure Container Apps, Azure Kubernetes Service, Azure App Service, or VMs. 
 
-### Prerequisites
+![Durable Task Scheduler in all Azure Computes](./media/images/portable-sdks/dts-in-all-computes.png)
 
-(ideally very short, if any)
+For more information on how to use the Azure Functions durable task scheduler and to explore its features, please refer to the [official documentation](https://aka.ms/dts-documentation)
 
-- OS
-- Library version
-- ...
+## Choosing your orchestration framework
+This repo contains samples in different directories for all orchestration frameworks supported by the durable task scheduler. The following table provides some considerations when choosing a framework. 
 
-### Installation
+|Consideration | Portable SDKs | Durable Functions | Durable Task Framework|
+|--------------| --------------| ------------------| --------------------- | 
+|Hosting option| Azure Container Apps, Azure Kubernetes Service, Azure App Service, VMs | Azure Functions | Azure Container Apps, Azure Kubernetes Service, Azure App Service, VMs |
+|Language support | [.NET](https://github.com/microsoft/durabletask-dotnet/), [Python](https://github.com/microsoft/durabletask-python), [Java (coming soon)](https://github.com/microsoft/durabletask-java), [JavaScript (coming soon)](https://github.com/microsoft/durabletask-js) | [.NET](https://github.com/Azure/azure-functions-durable-extension), [Python](https://github.com/Azure/azure-functions-durable-python), [Java](https://github.com/microsoft/durabletask-java), [JavaScript](https://github.com/Azure/azure-functions-durable-js), [PowerShell](https://github.com/Azure/azure-functions-powershell-worker/tree/dev/examples/durable) | [.NET](https://github.com/Azure/durabletask) |
+|Official support| No | Yes | No |
+|Durable task scheduler emulator| Available | Available |Available |
+|Monitoring dashboard| Available | Available <sup>1</sup> | Available <sup>1</sup>|
+|[Durable Entities](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-entities)| Not supported | Supported | Not supported|
+|Other supported feature(s)| Scheduler| Azure Functions triggers and bindings ||
 
-(ideally very short)
+*<sup>1</sup> The out-of-the-box monitoring dashboard is available only when using the durable task scheduler as the backend provider.*
 
-- npm install [package name]
-- mvn install
-- ...
+> **Note:** For all **new apps**, we recommend the portable SDKs over the Durable Task Framework as the former follows more modern .NET conventions and will be the focus of our future investments.
 
-### Quickstart
-(Add steps to get up and running quickly)
+## Tell us what you think
 
-1. git clone [repository clone url]
-2. cd [repository name]
-3. ...
+Your feedback is essential in shaping the future direction of this product. We encourage you to share your experiences, both the good and the bad. If there are any missing features or capabilities that you would like to see supported in the Durable Task Scheduler, we want to hear about them.
 
-
-## Demo
-
-A demo app is included to show how to use the project.
-
-To run the demo, follow these steps:
-
-(Add steps to start up the demo)
-
-1.
-2.
-3.
-
-## Resources
-
-(Any additional resources or related projects)
-
-- Link to supporting information
-- Link to similar sample
-- ...
+> **Note:** This is an early-stage version of the product. You can share your feedback either by dropping us an issue in this repo (other private preview users will see your issue) or send an email to our product managers Nick and Lily ([nicholas.greenfield@microsoft.com](mailto:nicholas.greenfield@microsoft.com); [jiayma@microsoft.com](mailto:jiayma@microsoft.com)).
diff --git a/media/images/OrderProcessor/container-ports.png b/media/images/OrderProcessor/container-ports.png
diff --git a/media/images/OrderProcessor/dashboard-overview.png b/media/images/OrderProcessor/dashboard-overview.png
diff --git a/media/images/OrderProcessor/dashboard-url.png b/media/images/OrderProcessor/dashboard-url.png
diff --git a/media/images/OrderProcessor/input-output.png b/media/images/OrderProcessor/input-output.png
diff --git a/media/images/OrderProcessor/instance-details.png b/media/images/OrderProcessor/instance-details.png
diff --git a/media/images/OrderProcessor/resource-group.png b/media/images/OrderProcessor/resource-group.png
diff --git a/media/images/OrderProcessor/taskhub.png b/media/images/OrderProcessor/taskhub.png
diff --git a/media/images/PdfSummarizer/architecture_v3.png b/media/images/PdfSummarizer/architecture_v3.png
diff --git a/media/images/PdfSummarizer/dotnet-code.png b/media/images/PdfSummarizer/dotnet-code.png
diff --git a/media/images/activity.png b/media/images/activity.png
diff --git a/media/images/architecture_v2.png b/media/images/architecture_v2.png
diff --git a/media/images/architecture_v3.png b/media/images/architecture_v3.png
diff --git a/media/images/code.png b/media/images/code.png
diff --git a/media/images/connecting-dts.png b/media/images/connecting-dts.png
diff --git a/media/images/dashboard.png b/media/images/dashboard.png
diff --git a/media/images/dotnet-code.png b/media/images/dotnet-code.png
diff --git a/media/images/dtfx/dtfx-sample-dashboard.png b/media/images/dtfx/dtfx-sample-dashboard.png
diff --git a/media/images/dts-connected.png b/media/images/dts-connected.png
diff --git a/media/images/dts-dashboard-resource.png b/media/images/dts-dashboard-resource.png
diff --git a/media/images/dts-overview-portal.png b/media/images/dts-overview-portal.png
diff --git a/media/images/portable-sdks/dts-in-all-computes.png b/media/images/portable-sdks/dts-in-all-computes.png
diff --git a/media/images/portable-sdks/portable-sample-dashboard.png b/media/images/portable-sdks/portable-sample-dashboard.png
diff --git a/media/images/sequence.png b/media/images/sequence.png
diff --git a/media/images/taskhub-overview-portal.png b/media/images/taskhub-overview-portal.png
diff --git a/media/images/taskhub-overview.png b/media/images/taskhub-overview.png
diff --git a/media/images/video_thumbnail.png b/media/images/video_thumbnail.png
diff --git a/quickstarts/dotnet/HelloCities/.devcontainer/Dockerfile b/quickstarts/dotnet/HelloCities/.devcontainer/Dockerfile
@@ -0,0 +1,27 @@
+FROM mcr.microsoft.com/vscode/devcontainers/universal:latest
+
+# Copy custom first notice message.
+COPY first-run-notice.txt /tmp/staging/
+RUN sudo mv -f /tmp/staging/first-run-notice.txt /usr/local/etc/vscode-dev-containers/ \
+    && sudo rm -rf /tmp/staging
+
+# Install PowerShell 7.x
+RUN sudo apt-get update \
+    && sudo apt-get install -y wget apt-transport-https software-properties-common \
+    && wget -q https://packages.microsoft.com/config/ubuntu/$(. /etc/os-release && echo $VERSION_ID)/packages-microsoft-prod.deb \
+    && sudo dpkg -i packages-microsoft-prod.deb \
+    && sudo apt-get update \
+    && sudo apt-get install -y powershell
+
+# Install Azure Functions Core Tools
+RUN curl https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.gpg \
+    && sudo mv microsoft.gpg /etc/apt/trusted.gpg.d/microsoft.gpg \
+    && sudo sh -c 'echo "deb [arch=amd64] https://packages.microsoft.com/repos/microsoft-ubuntu-$(lsb_release -cs)-prod $(lsb_release -cs) main" > /etc/apt/sources.list.d/dotnetdev.list' \
+    && sudo apt-get update \
+    && sudo apt-get install -y azure-functions-core-tools-4
+
+# Install Azure Developer CLI
+RUN curl -fsSL https://aka.ms/install-azd.sh | bash
+
+# Install mechanical-markdown for quickstart validations
+RUN pip install mechanical-markdown
diff --git a/quickstarts/dotnet/HelloCities/.devcontainer/devcontainer.json b/quickstarts/dotnet/HelloCities/.devcontainer/devcontainer.json
@@ -0,0 +1,36 @@
+{
+    "name": "Functions Quickstarts Codespace",
+    "dockerFile": "Dockerfile",
+    "features": {
+      "azure-cli": "latest"
+    },
+    "customizations": {
+      "vscode": {
+        "extensions": [
+          "ms-azuretools.vscode-bicep",
+          "ms-azuretools.vscode-docker",
+          "ms-azuretools.vscode-azurefunctions",
+          "GitHub.copilot",
+          "humao.rest-client"
+        ]
+      }
+    },
+    "mounts": [
+      // Mount docker-in-docker library volume
+      "source=codespaces-linux-var-lib-docker,target=/var/lib/docker,type=volume"
+    ],
+    // Always run image-defined docker-init.sh to enable docker-in-docker
+    "overrideCommand": false,
+    "remoteUser": "codespace",
+    "runArgs": [
+      // Enable ptrace-based debugging for Go in container
+      "--cap-add=SYS_PTRACE",
+      "--security-opt",
+      "seccomp=unconfined",
+
+      // Enable docker-in-docker configuration
+      "--init",
+      "--privileged"
+    ]
+  }
+
diff --git a/quickstarts/dotnet/HelloCities/.devcontainer/first-run-notice.txt b/quickstarts/dotnet/HelloCities/.devcontainer/first-run-notice.txt
@@ -0,0 +1,4 @@
+👋 Welcome to the Functions Codespace! You are on the Functions Quickstarts image.
+It includes everything needed to run through our tutorials and quickstart applications.
+
+📚 Functions docs can be found at: https://learn.microsoft.com/en-us/azure/azure-functions/
diff --git a/quickstarts/dotnet/HelloCities/.github/CODE_OF_CONDUCT.md b/quickstarts/dotnet/HelloCities/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
diff --git a/quickstarts/dotnet/HelloCities/.github/ISSUE_TEMPLATE.md b/quickstarts/dotnet/HelloCities/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,33 @@
+<!--
+IF SUFFICIENT INFORMATION IS NOT PROVIDED VIA THE FOLLOWING TEMPLATE THE ISSUE MIGHT BE CLOSED WITHOUT FURTHER CONSIDERATION OR INVESTIGATION
+-->
+> Please provide us with the following information:
+> ---------------------------------------------------------------
+
+### This issue is for a: (mark with an `x`)
+```
+- [ ] bug report -> please search issues before submitting
+- [ ] feature request
+- [ ] documentation issue or request
+- [ ] regression (a behavior that used to work and stopped in a new release)
+```
+
+### Minimal steps to reproduce
+>
+
+### Any log messages given by the failure
+>
+
+### Expected/desired behavior
+>
+
+### OS and Version?
+> Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)
+
+### Versions
+>
+
+### Mention any other details that might be useful
+
+> ---------------------------------------------------------------
+> Thanks! We'll be in touch soon.
diff --git a/quickstarts/dotnet/HelloCities/.github/PULL_REQUEST_TEMPLATE.md b/quickstarts/dotnet/HelloCities/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,45 @@
+## Purpose
+<!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? -->
+* ...
+
+## Does this introduce a breaking change?
+<!-- Mark one with an "x". -->
+```
+[ ] Yes
+[ ] No
+```
+
+## Pull Request Type
+What kind of change does this Pull Request introduce?
+
+<!-- Please check the one that applies to this PR using "x". -->
+```
+[ ] Bugfix
+[ ] Feature
+[ ] Code style update (formatting, local variables)
+[ ] Refactoring (no functional changes, no api changes)
+[ ] Documentation content changes
+[ ] Other... Please describe:
+```
+
+## How to Test
+*  Get the code
+
+```
+git clone [repo-address]
+cd [repo-name]
+git checkout [branch-name]
+npm install
+```
+
+* Test the code
+<!-- Add steps to run the tests suite and/or manually test -->
+```
+```
+
+## What to Check
+Verify that the following are valid
+* ...
+
+## Other Information
+<!-- Add any other helpful information that may be needed here. -->