### Install npm packages Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-portable-durable-task-sdks?source=recommendations&tabs=linux Install the necessary npm packages before starting the worker or client. ```bash npm install ``` -------------------------------- ### Example Request to Start Orchestrator Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-http-api An example HTTP POST request to start a 'RestartVMs' orchestrator function, including a JSON payload for input parameters. ```HTTP POST /runtime/webhooks/durabletask/orchestrators/RestartVMs?code=XXX Content-Type: application/json Content-Length: 83 { "resourceGroup": "myRG", "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e" } ``` -------------------------------- ### Start an Orchestration Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-http-api?source=recommendations Example of initiating an orchestration using a POST request and the resulting response containing management URIs. ```Bash curl -X POST "http://localhost:7071/runtime/webhooks/durabletask/orchestrators/ProcessOrder" \ -H "Content-Type: application/json" \ -d '{ "orderId": "ORD-12345", "customerId": "CUST-789", "amount": 150.00 }' ``` ```JSON { "id": "abc123def456", "statusQueryGetUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123def456?code=XXX", "sendEventPostUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123def456/raiseEvent/{eventName}?code=XXX", "terminatePostUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123def456/terminate?reason={text}&code=XXX" } ``` -------------------------------- ### Start an orchestration instance with a specific version Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-orchestration-versioning Use these examples to initiate a new orchestration instance with a custom version string. ```C# [Function("HttpStart")] public static async Task HttpStart( [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req, [DurableClient] DurableTaskClient client, FunctionContext executionContext) { var options = new StartOrchestrationOptions { Version = "1.0" }; string instanceId = await client.ScheduleNewOrchestrationInstanceAsync( "ProcessOrderOrchestrator", orderId, options); // ... } ``` ```JavaScript const HttpStart: HttpHandler = async (request: HttpRequest, context: InvocationContext): Promise => { const client = df.getClient(context); const instanceId = await client.startNew("ProcessOrderOrchestrator", { input: orderId, version: "1.0" }); // ... }; ``` ```Python @myApp.route(route="orchestrators/{functionName}") @myApp.durable_client_input(client_name="client") async def http_start(req: func.HttpRequest, client): instance_id = await client.start_new("ProcessOrderOrchestrator", client_input=order_id, version="1.0") # ... ``` ```PowerShell param($Request, $TriggerMetadata) $instanceId = Start-DurableOrchestration -FunctionName "ProcessOrderOrchestrator" -Input $orderId -Version "1.0" # ... ``` ```Java @FunctionName("HttpStart") public HttpResponseMessage httpStart( @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage> request, @DurableClientInput(name = "durableContext") DurableClientContext durableContext, final ExecutionContext context) { DurableTaskClient client = durableContext.getClient(); NewOrchestrationInstanceOptions options = new NewOrchestrationInstanceOptions().setVersion("1.0"); String instanceId = client.scheduleNewOrchestrationInstance( "ProcessOrderOrchestrator", orderId, options); // ... ``` -------------------------------- ### C# Example Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-instance-management Example of how to use the `CreateHttpManagementPayload` method in C# to get webhook URLs and store them in Azure Cosmos DB. ```csharp using Microsoft.Azure.WebJobs; using Microsoft.Azure.WebJobs.Extensions.DurableFunctions; using Microsoft.Azure.WebJobs.Extensions.CosmosDB; public static class SendInstanceInfo { [FunctionName("SendInstanceInfo")] public static void SendInstanceInfo( [ActivityTrigger] IDurableActivityContext ctx, [DurableClient] IDurableOrchestrationClient client, [CosmosDB( databaseName: "MonitorDB", containerName: "HttpManagementPayloads", Connection = "CosmosDBConnectionSetting")]out dynamic document) { HttpManagementPayload payload = client.CreateHttpManagementPayload(ctx.InstanceId); // send the payload to Azure Cosmos DB document = new { Payload = payload, id = ctx.InstanceId }; } } ``` -------------------------------- ### Start Local Infrastructure Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/durable-task-scheduler-opentelemetry-tracing?pivots=durable-functions&tabs=csharp Command to start the defined Docker services. ```bash docker compose up -d ``` -------------------------------- ### Execute Fan-Out/Fan-In Pattern Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-portable-durable-task-sdks Commands to install dependencies, start the worker process, and trigger the client orchestration. ```bash npm install ``` ```bash npm run worker ``` ```bash npm run client ``` ```bash npm run client -- 15 ``` -------------------------------- ### Install project dependencies Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/quickstart-python-vscode?source=recommendations Install the packages specified in requirements.txt using pip. ```bash python -m pip install -r requirements.txt ``` -------------------------------- ### Install all extensions via CLI Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-extension-upgrade Installs the latest versions of all extensions supported by Extension Bundles. ```bash func extensions install ``` -------------------------------- ### Example profile.ps1 Configuration Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-powershell-v2-sdk-migration-guide A sample profile.ps1 file demonstrating how to initialize the environment and authenticate with MSI. ```powershell # Azure Functions profile.ps1 # # This profile.ps1 will get executed every "cold start" of your Function App. # "cold start" occurs when: # # * A Function App starts up for the very first time # * A Function App starts up after being de-allocated due to inactivity # # You can define helper functions, run commands, or specify environment variables # NOTE: any variables defined that are not environment variables will get reset after the first execution # Authenticate with Azure PowerShell using MSI. # Remove this if you are not planning on using MSI or Azure PowerShell. if ($env:MSI_SECRET) { Disable-AzContextAutosave -Scope Process | Out-Null Connect-AzAccount -Identity } # Uncomment the next line to enable legacy AzureRm alias in Azure PowerShell. # Enable-AzureRmAlias # You can also define functions or aliases that can be referenced in any of your PowerShell functions. ``` -------------------------------- ### Navigate to Sample Directory Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/durable-task-scheduler-auto-scaling?tabs=portal Use this command to navigate into the specific sample directory for deployment. ```bash cd /path/to/Durable-Task-Scheduler/samples/scenarios/AutoscalingInACA ``` -------------------------------- ### Install specific Durable Functions extension version example Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-extension-upgrade?source=recommendations An example of how to install a specific version of the Durable Functions extension, in this case, version 2.9.1. ```console func extensions install -p Microsoft.Azure.WebJobs.Extensions.DurableTask -v 2.9.1 ``` -------------------------------- ### Navigate to .NET SDK sample directory Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-portable-durable-task-sdks?source=recommendations&tabs=linux Change directory to the .NET SDK sample for Durable Task Scheduler. ```bash cd samples/durable-task-sdks/dotnet/FanOutFanIn ``` -------------------------------- ### Build the sample project Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-work-item-filtering-durable-task Compile the .NET project before running the workers. ```bash dotnet build ``` -------------------------------- ### Get Entity Example Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-http-api Example request and response for retrieving the state of a 'Counter' entity. ```HTTP GET /runtime/webhooks/durabletask/entities/Counter/steps ``` ```JSON { "currentValue": 5 } ``` -------------------------------- ### Navigate to sample directory Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-work-item-filtering-durable-task Change the working directory to the specific sample location. ```bash cd samples/scenarios/WorkItemFilteringSplitActivities ``` -------------------------------- ### Example HTTP Response for Orchestration Start Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-http-features?source=recommendations&tabs=csharp-inproc This is an example of the HTTP 202 Accepted response received after successfully starting a Durable Functions orchestration. It includes URIs for checking status, sending events, and terminating the instance. ```http HTTP/1.1 202 Accepted Content-Type: application/json; charset=utf-8 Location: http://localhost:7071/runtime/webhooks/durabletask/instances/abc123?code=XXX Retry-After: 10 { "id": "abc123", "purgeHistoryDeleteUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123?code=XXX", "sendEventPostUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123/raiseEvent/{eventName}?code=XXX", "statusQueryGetUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123?code=XXX", "terminatePostUri": "http://localhost:7071/runtime/webhooks/durabletask/instances/abc123/terminate?reason={text}&code=XXX" } ``` -------------------------------- ### Navigate to SDK sample directories Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-portable-durable-task-sdks Commands to change the working directory to the specific SDK sample folder. ```Bash cd samples/durable-task-sdks/dotnet/FanOutFanIn ``` ```Bash cd samples/durable-task-sdks/python/fan-out-fan-in ``` ```Bash cd samples/durable-task-sdks/java/fan-out-fan-in ``` ```Bash cd samples/durable-task-sdks/javascript/fan-out-fan-in ``` -------------------------------- ### C# Example for Getting Status Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-instance-management?tabs=csharp An example demonstrating how to use the `GetStatusAsync` method in C# to retrieve the status of an orchestration instance. ```csharp ```csharp [FunctionName("GetStatus")] public static async Task Run( [DurableClient] IDurableOrchestrationClient client, [QueueTrigger("check-status-queue")] string instanceId) { DurableOrchestrationStatus status = await client.GetStatusAsync(instanceId); // do something based on the current status. } ``` ``` -------------------------------- ### Navigate to Java SDK sample directory Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-portable-durable-task-sdks?source=recommendations&tabs=linux Change directory to the Java SDK sample for Durable Task Scheduler. ```bash cd samples/durable-task-sdks/java/fan-out-fan-in ``` -------------------------------- ### Start Orchestration from Entity Operation Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-dotnet-entities?source=recommendations An example of an entity operation that starts a new orchestration when a condition is met, passing the entity ID as an input. ```csharp public void Add(int amount) { if (this.Value < 100 && this.Value + amount >= 100) { Entity.Current.StartNewOrchestration("MilestoneReached", Entity.Current.EntityId); } this.Value += amount; } ``` -------------------------------- ### Example Client Output (Fan-Out/Fan-In) Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-portable-durable-task-sdks?source=recommendations&tabs=linux This output shows the client initiating a fan-out/fan-in orchestration, processing parallel tasks, and aggregating the results. ```text Starting fan out/fan in orchestration with 10 items Waiting for 10 parallel tasks to complete Orchestrator yielded with 10 task(s) and 0 event(s) outstanding. Processing work item: 1 Processing work item: 2 Processing work item: 10 Processing work item: 9 Processing work item: 8 Processing work item: 7 Processing work item: 6 Processing work item: 5 Processing work item: 4 Processing work item: 3 Orchestrator yielded with 9 task(s) and 0 event(s) outstanding. Orchestrator yielded with 8 task(s) and 0 event(s) outstanding. Orchestrator yielded with 7 task(s) and 0 event(s) outstanding. Orchestrator yielded with 6 task(s) and 0 event(s) outstanding. Orchestrator yielded with 5 task(s) and 0 event(s) outstanding. Orchestrator yielded with 4 task(s) and 0 event(s) outstanding. Orchestrator yielded with 3 task(s) and 0 event(s) outstanding. Orchestrator yielded with 2 task(s) and 0 event(s) outstanding. Orchestrator yielded with 1 task(s) and 0 event(s) outstanding. All parallel tasks completed, aggregating results Orchestrator yielded with 1 task(s) and 0 event(s) outstanding. Aggregating results from 10 items Orchestration completed with status: COMPLETED ``` -------------------------------- ### Get Orchestration Status in JavaScript Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-instance-management?source=recommendations Use the `durable-functions` npm package to get the status of a running orchestration instance by its ID. Ensure the `durable-functions` package is installed. ```javascript const df = require("durable-functions"); module.exports = async function(context, instanceId) { const client = df.getClient(context); const status = await client.getStatus(instanceId); // do something based on the current status. // example: if status.runtimeStatus === df.OrchestrationRuntimeStatus.Running: ... } ``` -------------------------------- ### HTTP GET Request for Orchestration Instance Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-custom-orchestration-status This is an example of an HTTP GET request to retrieve the status of a specific orchestration instance. The URL includes the instance ID. ```HTTP GET /runtime/webhooks/durabletask/instances/instance123 ``` -------------------------------- ### Navigate to Durable Task SDK Sample Directory (C#) Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-task-scheduler/quickstart-container-apps-durable-task-sdk Navigate to the C# sample directory for Durable Task SDKs. Ensure you have .NET 8 SDK or later installed, Docker for the emulator, and Azure Developer CLI. ```bash cd /samples/durable-task-sdks/dotnet/FunctionChaining ``` -------------------------------- ### Start Orchestration with Task Hub in C# Source: https://learn.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-task-hubs?source=recommendations&tabs=csharp%2Cportal Use the DurableClient attribute with the TaskHub property set to an app setting to start a new orchestration. This example is for Durable Functions 2.x. ```csharp [FunctionName("HttpStart")] public static async Task Run( [HttpTrigger(AuthorizationLevel.Function, methods: "post", Route = "orchestrators/{functionName}")] HttpRequestMessage req, [DurableClient(TaskHub = "%MyTaskHub%")] IDurableOrchestrationClient starter, string functionName, ILogger log) { // Function input comes from the request content. object eventData = await req.Content.ReadAsAsync