This directory is the canonical home of the official Orleans samples.
Samples imported from other Microsoft repositories retain their original source repository in the index and in gallery.json. Their source licenses are preserved alongside the imported content.
From the repository root, run:
pwsh ./samples/Validate-Samples.ps1The command checks the gallery manifest and builds every project in Samples.slnx. External cloud services are required only when running samples which use them, not when compiling.
| Sample | Description | Original source |
|---|---|---|
| Adventure | A text adventure game demonstrating grains, external clients, and application modeling. | dotnet/samples |
| Chirper | A social network sample using persistence, observers, and reentrant grains. | dotnet/samples |
| GPS Tracker | An IoT location tracker integrating Orleans with ASP.NET Core SignalR. | dotnet/samples |
| Hello World | The smallest complete Orleans application for defining and calling a grain. | dotnet/samples |
| Journaled Todo List | An Aspire-hosted Web application demonstrating durable journaled grain state. | dotnet/samples |
| Presence Service | A gaming presence service using observers and multiple cooperating grains. | dotnet/samples |
| Shopping Cart | A Blazor shopping cart using Orleans persistence and Azure Storage. | dotnet/samples |
| Azure App Service Deployment | A Windows and Linux Azure App Service deployment with managed identity, private silo networking, health checks, Easy Auth, Bicep, and OIDC. | dotnet/orleans |
| Azure Container Apps Deployment | A managed-identity Orleans cluster with clients, dashboard, scaler, and Bicep deployment for Azure Container Apps. | Azure-Samples/Orleans-Cluster-on-Azure-Container-Apps |
| Sample | Description | Languages | Tags | Original source |
|---|---|---|---|---|
| Adventure | A text adventure game demonstrating grains, external clients, and application modeling. | C# | games, clients, grains | dotnet/samples |
| AWS Kinesis and DynamoDB | An AWS-hosted Orleans application using DynamoDB for clustering, persistence, reminders, and Kinesis checkpoints. | C# | aws, kinesis, dynamodb, streaming | dotnet/orleans |
| Bank Account | A bank transfer simulation demonstrating ACID transactions across stateful grains. | C# | transactions, persistence | dotnet/samples |
| Basic Clustering | A minimal Aspire-hosted Orleans cluster with two silo replicas and Redis membership. | C# | clustering, aspire, redis, getting-started | dotnet/orleans |
| Blazor Server | An interactive Blazor Server application backed by Orleans grains. | C#, Razor | blazor, aspnet-core, web | dotnet/samples |
| Blazor WebAssembly | A hosted Blazor WebAssembly application with an Orleans-backed server. | C#, Razor | blazor, webassembly, web | dotnet/samples |
| Chat Room | A terminal chat application demonstrating Orleans Streams. | C# | streaming, client, terminal | dotnet/samples |
| Chirper | A social network sample using persistence, observers, and reentrant grains. | C# | observers, persistence, reentrancy | dotnet/samples |
| Custom grain-call return type | An awaitable GrainCall extension demonstrating generated request bases, proxy adaptation, and failure propagation. | C# | serialization, code-generation, grains | dotnet/orleans |
| F# Hello World | A minimal Orleans application with grains implemented in F#. | F#, C# | getting-started, fsharp | dotnet/samples |
| GPS Tracker | An IoT location tracker integrating Orleans with ASP.NET Core SignalR. | C#, JavaScript | iot, signalr, web | dotnet/samples |
| Google Cloud Firestore | An Orleans application using Firestore for clustering, grain directories, persistence, and reminders. | C# | google-cloud, firestore, clustering, persistence, reminders | dotnet/orleans |
| Hello World | The smallest complete Orleans application for defining and calling a grain. | C# | getting-started, grains | dotnet/samples |
| Journaled Todo List | An Aspire-hosted Web application demonstrating durable journaled grain state. | C#, Razor | journaling, aspire, web | dotnet/samples |
| Durable Jobs provider migration | Drain existing jobs from Azure Blob provider A while provider B accepts new work, with process restart and full-inventory checks. | C# | durable-jobs, journaling, azure-storage, aspire | dotnet/orleans |
| Journaling with Azure Blob JSON | An Aspire sample using Orleans journaling with JSON events stored in Azure Blob Storage. | C# | journaling, azure-storage, aspire | dotnet/orleans |
| Presence Service | A gaming presence service using observers and multiple cooperating grains. | C# | gaming, observers, services | dotnet/samples |
| Shopping Cart | A Blazor shopping cart using Orleans persistence and Azure Storage. | C#, Razor | blazor, persistence, azure-storage | dotnet/samples |
| Stocks | A stock price application using grain timers, HTTP calls, and temporary caching. | C#, Razor | timers, http, caching | dotnet/samples |
| Streaming Custom Data Adapter | An Event Hubs streaming sample consuming data from a non-Orleans publisher. | C# | streaming, event-hubs, azure | dotnet/samples |
| Simple Streaming | A compact producer and consumer example using Orleans Streams. | C# | streaming, getting-started | dotnet/samples |
| Tic Tac Toe | A Web-based game demonstrating lobbies and ASP.NET Core integration. | C#, JavaScript | games, aspnet-core, web | dotnet/samples |
| Transport Layer Security | A Hello World cluster configured with mutual TLS for all network communication. | C# | security, tls, networking | dotnet/samples |
| Visual Basic Hello World | A minimal Orleans application with grain contracts and implementations in Visual Basic. | Visual Basic, C# | getting-started, visual-basic | dotnet/samples |
| Voting | A Kubernetes-oriented voting Web application with the Orleans Dashboard. | C#, Razor | kubernetes, dashboard, web | dotnet/samples |
| Azure App Service Deployment | A Windows and Linux Azure App Service deployment with managed identity, private silo networking, health checks, Easy Auth, Bicep, and OIDC. | C#, Razor, Bicep, YAML | deployment, azure, app-service, windows, linux | dotnet/orleans |
| Azure Container Apps Deployment | A managed-identity Orleans cluster with clients, dashboard, scaler, and Bicep deployment for Azure Container Apps. | C#, Bicep, YAML | deployment, azure, container-apps, managed-identity, networking | Azure-Samples/Orleans-Cluster-on-Azure-Container-Apps |