Microsoft Orleans documentation

Learn to use the Orleans SDK for .NET. Browse API reference, sample code, tutorials, quickstarts, conceptual articles and more.

Overview

Introduction to Orleans

Deploy

Deploy Orleans apps

What's new

Migrate from Orleans 3.x to 7.0

Concept

Why Orleans?

Get started

Develop a grain

Overview

Orleans transactions

Featured content

Learn to develop cloud native .NET Orleans apps.

Get started with Orleans

• Grain lifecycle
• Grain identity
• Grain placement
• Code generation
• Stateless worker grains

Work with grains

• Grain persistence
• Grain event sourcing
• Grain versioning
• Grain services
• Grain observers
• Grain interceptors

Deploy Orleans apps

• Kubernetes deployment
• Docker deployment
• Service Fabric deployment
• Consul deployment
• Azure App Service
• Azure Container Apps
• Multi-cluster deployment

Host Orleans apps

• Host configuration
• Observability
• Orleans clients
• Use the grain directory
• Heterogeneous silos
• Silo lifecycle

Orleans architecture

• Implementation details overview
• Load balancing
• Orleans lifecycles
• Cluster management
• Message delivery guarantees
• Streaming queues

Video content

• An introduction to Orleans
• Building real applications with Orleans
• Building distributed applications with Orleans
• Deploying Orleans Apps to Kubernetes
• Clustering in Orleans
• Setting up Observability in Orleans

.NET community resources

.NET

• .NET documentation
• ASP.NET documentation
• Azure documentation
• C# documentation

Webcasts and shows

• Azure Friday
• The Cloud Native Show
• On .NET
• .NET Community Standup
• On .NET Live

Open source

• Orleans on GitHub
• Orleans samples on GitHub
• .NET samples
• .NET Platform

Interact

• Chat on Discord
• Follow @msftorleans on Twitter
• Participate in discussions
• Post an issue (or propose a feature)
• Comment on pull requests

API and language reference

Search the .NET API and language reference documentation.

.NET Orleans core API reference

API reference documentation for .NET Orleans.Core

.NET Orleans runtime API reference

API reference documentation for .NET Orleans.Runtime

.NET Orleans streams API reference

API reference documentation for .NET Orleans.Streams

.NET Orleans providers API reference

API reference documentation for .NET Orleans.Providers

.NET Orleans storage API reference

API reference documentation for .NET Orleans.Storage

.NET Orleans Azure Storage API reference

API reference documentation for .NET Orleans.Clustering.AzureStorage

.NET Orleans services API reference

API reference documentation for .NET Orleans.Services

.NET Orleans transactions API reference

API reference documentation for .NET Orleans.Transactions

Are you interested in contributing to the .NET docs? For more information, see our contributor guide.