Microsoft.Orleans.Sdk 9.2.1

Prefix Reserved
dotnet add package Microsoft.Orleans.Sdk --version 9.2.1
                    
NuGet\Install-Package Microsoft.Orleans.Sdk -Version 9.2.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Orleans.Sdk" Version="9.2.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Microsoft.Orleans.Sdk" Version="9.2.1" />
                    
Directory.Packages.props
<PackageReference Include="Microsoft.Orleans.Sdk" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Microsoft.Orleans.Sdk --version 9.2.1
                    
#r "nuget: Microsoft.Orleans.Sdk, 9.2.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Microsoft.Orleans.Sdk@9.2.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Microsoft.Orleans.Sdk&version=9.2.1
                    
Install as a Cake Addin
#tool nuget:?package=Microsoft.Orleans.Sdk&version=9.2.1
                    
Install as a Cake Tool

Microsoft Orleans SDK

Introduction

Microsoft Orleans SDK is a metapackage that includes all the necessary components to build Orleans applications. It provides both client and server functionality, making it easy to get started with Orleans without having to reference individual packages.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Sdk

Example - Creating a Grain Interface and Implementation

// Define a grain interface
public interface IHelloGrain : IGrainWithStringKey
{
    Task<string> SayHello(string greeting);
}

// Implement the grain interface
public class HelloGrain : Grain, IHelloGrain
{
    public Task<string> SayHello(string greeting)
    {
        return Task.FromResult($"Hello, {greeting}!");
    }
}

Example - Configuring an Orleans Application

using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;
using Microsoft.Extensions.DependencyInjection;
using System;
using System.Threading.Tasks;
namespace ExampleGrains;

// Create the host
var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering();
    });

// Start the host
var host = builder.Build();
await host.StartAsync();

// Get a reference to a grain and call it
var client = host.Services.GetRequiredService<IClusterClient>();
var grain = client.GetGrain<IHelloGrain>("user123");
var response = await grain.SayHello("World");

// Print the result
Console.WriteLine($"Grain response: {response}");

// Keep the host running until the application is shut down
await host.WaitForShutdownAsync();

Documentation

For more comprehensive documentation, please refer to:

Feedback & Contributing

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

NuGet packages (98)

Showing the top 5 NuGet packages that depend on Microsoft.Orleans.Sdk:

Package Downloads
Microsoft.Orleans.Client

Collection of Microsoft Orleans libraries and files needed on the client.

Microsoft.Orleans.Server

Collection of Microsoft Orleans libraries and files needed on the server.

OrleansDashboard

A developer dashboard for Microsoft Orleans

OrleansDashboard.Core

A developer dashboard for Microsoft Orleans

Microsoft.Orleans.Reminders

Reminders library for Microsoft Orleans used on the server.

GitHub repositories (12)

Showing the top 12 popular GitHub repositories that depend on Microsoft.Orleans.Sdk:

Repository Stars
dotnet/aspire
Tools, templates, and packages to accelerate building observable, production-ready apps
dotnet/samples
Sample code referenced by the .NET documentation
Dotnet-Boxed/Templates
.NET project templates with batteries included, providing the minimum amount of code required to get you going faster.
OrleansContrib/OrleansDashboard
:bar_chart: A developer dashboard for Microsoft Orleans
dotnet/dotnet
Home of .NET's Virtual Monolithic Repository which includes all the code needed to build the .NET SDK.
OrleansContrib/Orleankka
Functional API for Microsoft Orleans http://orleanscontrib.github.io/Orleankka
RayTale/Vertex
Vertex is a distributed, ultimately consistent, event traceable cross platform framework based on Orleans, which is used to build high-performance, high throughput, low latency, scalable distributed applications
microsoft/project-oagents
Experimental AI Agents Framework
OrleansContrib/Orleans.Clustering.Kubernetes
Orleans Membership provider for Kubernetes
OrleansContrib/Orleans.Sagas
A distributed saga implementation for Orleans
PiotrJustyna/road-to-orleans
This repository illustrates the road to orleans with practical, real-life examples. From most basic, to more advanced techniques.
shinyorg/templates
dotnet CLI & Visual Studio Templates
Version Downloads Last Updated
9.2.1 4 7/16/2025
9.2.0 2,065 7/14/2025
9.2.0-preview3 2,776 6/10/2025
9.2.0-preview2 847 6/4/2025
9.2.0-preview1 24,928 4/4/2025
9.1.2 393,630 2/13/2025
9.0.1 257,135 11/23/2024
9.0.0 24,844 11/14/2024
8.2.0 942,485 7/12/2024
8.2.0-preview1 5,302 5/22/2024
8.1.0 485,727 4/17/2024
8.1.0-preview3 4,591 3/11/2024
8.1.0-preview2 1,276 2/23/2024
8.1.0-preview1 1,849 2/13/2024
8.0.0 508,932 1/5/2024
8.0.0-rc2 2,094 12/20/2023
8.0.0-rc1 1,586 12/4/2023
7.2.7 8,284 10/15/2024
7.2.6 80,055 3/9/2024
7.2.5 19,889 2/22/2024
7.2.4 377,268 12/2/2023
7.2.3 145,749 11/3/2023
7.2.2 83,338 10/16/2023
7.2.1 574,554 7/11/2023
7.2.0 288,121 7/7/2023
7.1.2 268,112 4/19/2023
7.1.1 114,949 3/23/2023
7.1.0 277,466 2/1/2023
7.0.0 264,833 11/8/2022
7.0.0-rc2 1,855 10/19/2022
4.0.0-preview2 21,168 8/4/2022
4.0.0-preview1 10,353 2/10/2022