Microsoft.Orleans.Clustering.AzureStorage 9.2.1

Prefix Reserved

dotnet add package Microsoft.Orleans.Clustering.AzureStorage --version 9.2.1

NuGet\Install-Package Microsoft.Orleans.Clustering.AzureStorage -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.Clustering.AzureStorage" 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.Clustering.AzureStorage" Version="9.2.1" />
                    

                            Directory.Packages.props

<PackageReference Include="Microsoft.Orleans.Clustering.AzureStorage" />
                    

                            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.Clustering.AzureStorage --version 9.2.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Microsoft.Orleans.Clustering.AzureStorage, 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.Clustering.AzureStorage@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.Clustering.AzureStorage&version=9.2.1
                    

                            Install as a Cake Addin

#tool nuget:?package=Microsoft.Orleans.Clustering.AzureStorage&version=9.2.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Microsoft Orleans Clustering Provider for Azure Storage

Introduction

Microsoft Orleans Clustering Provider for Azure Storage allows Orleans silos to organize themselves as a cluster using Azure Table Storage. This provider enables silos to discover each other, maintain cluster membership, and detect and handle failures.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Clustering.AzureStorage

Example - Configuring Azure Storage Clustering

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

// 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}!");
    }
}

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            // Configure Azure Table Storage for clustering
            .UseAzureStorageClustering(options =>
            {
                options.ConnectionString = "YOUR_AZURE_STORAGE_CONNECTION_STRING";
                options.TableName = "OrleansClustering"; // Optional: defaults to "OrleansClustering"
            });
    });

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();

Example - Configuring Client to Connect to Cluster

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

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

var clientBuilder = Host.CreateApplicationBuilder(args)
    .UseOrleansClient(clientBuilder =>
    {
        clientBuilder
            // Configure the client to use Azure Storage for clustering
            .UseAzureStorageClustering(options =>
            {
                options.ConnectionString = "YOUR_AZURE_STORAGE_CONNECTION_STRING";
                options.TableName = "OrleansClustering"; // Optional: defaults to "OrleansClustering"
            });
    });

var host = clientBuilder.Build();
await host.StartAsync();
var client = host.Services.GetRequiredService<IClusterClient>();

// Get a reference to a grain and call it
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

If you have any issues or would like to provide feedback, please open an issue on GitHub
Join our community on Discord
Follow the @msftorleans Twitter account for Orleans announcements
Contributions are welcome! Please review our contribution guidelines
This project is licensed under the MIT license

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Azure.Core (>= 1.46.2)
- Azure.Data.Tables (>= 12.9.1)
- Microsoft.AspNetCore.Connections.Abstractions (>= 8.0.11)
- Microsoft.CodeAnalysis.Analyzers (>= 3.11.0)
- Microsoft.CodeAnalysis.Common (>= 4.5.0)
- Microsoft.CodeAnalysis.Workspaces.Common (>= 4.5.0)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Json (>= 8.0.1)
- Microsoft.Extensions.DependencyInjection (>= 8.0.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.DependencyModel (>= 8.0.2)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Logging.Console (>= 8.0.1)
- Microsoft.Extensions.Logging.Debug (>= 8.0.1)
- Microsoft.Extensions.ObjectPool (>= 8.0.11)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
- Microsoft.Orleans.Analyzers (>= 9.2.1)
- Microsoft.Orleans.CodeGenerator (>= 9.2.1)
- Microsoft.Orleans.Runtime (>= 9.2.1)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 8.0.0)
- System.IO.Hashing (>= 8.0.0)
- System.IO.Pipelines (>= 8.0.0)
- System.Memory.Data (>= 8.0.1)
- System.Text.Json (>= 8.0.5)

NuGet packages (9)

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

Package	Downloads
Blauhaus.Orleans Package Description	1.1M
Blauhaus.EVACS.Orleans Package Description	987.3K
Aksio.Cratis.Extensions.Orleans Package Description	819.7K
Microsoft.Orleans.OrleansAzureUtils Support library for hosting Orleans on Microsoft Azure.	339.9K
Aksio.Cratis.Kernel.Orleans Package Description	77.2K

GitHub repositories (8)

Showing the top 8 popular GitHub repositories that depend on Microsoft.Orleans.Clustering.AzureStorage:

Repository	Stars
dotnet/aspire Tools, templates, and packages to accelerate building observable, production-ready apps	4.8K
Dotnet-Boxed/Templates .NET project templates with batteries included, providing the minimum amount of code required to get you going faster.	3.5K
microsoft/dotnet-podcasts .NET reference application shown at .NET Conf featuring ASP.NET Core, Blazor, .NET MAUI, Microservices, Orleans, Playwright, and more!	2.8K
dotnet/dotnet Home of .NET's Virtual Monolithic Repository which includes all the code needed to build the .NET SDK.	704
axzxs2001/Asp.NetCoreExperiment 原来所有项目都移动到OleVersion目录下进行保留。新的案例装以.net 5.0为主，一部分对以前案例进行升级，一部分将以前的工作经验总结出来，以供大家参考！	359
Samsung/Tizen.NET Welcome to Tizen .NET	237
J-Tech-Japan/Sekiban Sekiban - an Opinionated Event Sourcing and CQRS Framework using C#. It can store data into Azure Cosmos DB, AWS Dynamo DB or Postgres	193
ReubenBond/hanbaobao-web Orleans sample application with Kubernetes hosting	148

Version	Downloads	Last Updated
9.2.1	2,648	7/16/2025
9.2.0	474	7/14/2025
9.2.0-preview3	723	6/10/2025
9.2.0-preview2	164	6/4/2025
9.2.0-preview1	5,913	4/4/2025
9.1.2	108,181	2/13/2025
9.0.1	43,525	11/23/2024
9.0.0	4,762	11/14/2024
8.2.0	178,176	7/12/2024
8.2.0-preview1	321	5/22/2024
8.1.0	130,910	4/17/2024
8.1.0-preview3	1,544	3/11/2024
8.1.0-preview2	216	2/23/2024
8.1.0-preview1	1,316	2/13/2024
8.0.0	62,055	1/5/2024
8.0.0-rc2	317	12/20/2023
8.0.0-rc1	365	12/4/2023
7.2.7	748	10/15/2024
7.2.6	24,657	3/9/2024
7.2.5	6,010	2/22/2024
7.2.4	103,155	12/2/2023
7.2.3	20,947	11/3/2023
7.2.2	10,005	10/16/2023
7.2.1	98,324	7/11/2023
7.2.0	5,684	7/7/2023
7.1.2	57,458	4/19/2023
7.1.1	60,769	3/23/2023
7.1.0	88,346	2/1/2023
7.0.0	32,658	11/8/2022
7.0.0-rc2	413	10/19/2022
4.0.0-preview2	11,481	8/4/2022
4.0.0-preview1	4,609	2/10/2022
3.8.0	529	5/6/2025
3.8.0-preview5	264	5/12/2025
3.8.0-preview3	228	4/8/2025
3.8.0-preview2	170	4/4/2025
3.8.0-preview1	218	3/31/2025
3.7.2	21,973	5/10/2024
3.7.1	62,786	5/27/2023
3.7.0	62,442	3/23/2023
3.6.5	1,004,574	8/15/2022
3.6.4	19,175	8/10/2022
3.6.3	39,101	8/4/2022
3.6.2	591,731	4/15/2022
3.6.1	271,982	4/5/2022
3.6.0	231,486	1/20/2022
3.5.1	141,227	11/8/2021
3.5.0	108,750	9/3/2021
3.4.4	2,995	10/4/2021
3.4.3	113,422	6/3/2021
3.4.2	57,172	4/5/2021
3.4.1	63,967	2/3/2021
3.4.0	25,933	1/6/2021
3.4.0-rc1	783	12/9/2020
3.3.0	60,781	9/9/2020
3.3.0-rc2	1,826	9/2/2020
3.3.0-rc1	706	8/19/2020
3.2.2	14,468	7/22/2020
3.2.1	7,962	7/2/2020
3.2.0	10,019	6/4/2020
3.2.0-rc2	944	5/20/2020
3.2.0-rc1	979	5/7/2020
3.1.7	9,519	5/19/2020
3.1.6	23,624	4/16/2020
3.1.5	1,753	4/9/2020
3.1.4	20,861	3/26/2020
3.1.3	8,049	3/16/2020
3.1.2	5,925	3/5/2020
3.1.0	4,913	2/23/2020
3.1.0-rc3	858	2/13/2020
3.1.0-rc2	861	2/12/2020
3.1.0-rc1	854	2/10/2020
3.0.2	52,848	12/12/2019
3.0.1	5,579	11/27/2019
3.0.0	6,478	10/24/2019
3.0.0-rc2	1,018	10/16/2019
3.0.0-rc1	864	10/9/2019
3.0.0-beta1	1,332	8/16/2019
2.4.5	12,713	12/29/2019
2.4.4	12,886	11/27/2019
2.4.3	14,482	10/10/2019
2.4.2	13,177	8/31/2019
2.4.1	5,823	8/14/2019
2.4.0	6,626	8/8/2019
2.3.6	26,713	7/24/2019
2.3.5	25,134	6/14/2019
2.3.4	138,256	6/4/2019
2.3.3	2,943	6/2/2019
2.3.2	5,194	5/9/2019
2.3.1	3,926	4/26/2019
2.3.0	45,632	3/20/2019
2.3.0-rc2	2,198	3/13/2019
2.3.0-rc1	2,089	3/4/2019
2.2.4	5,130	2/25/2019
2.2.3	4,999	1/17/2019
2.2.0	15,246	12/13/2018
2.2.0-rc1	2,452	12/4/2018
2.2.0-beta1	2,795	10/21/2018
2.1.2	114,702	10/11/2018
2.1.0	5,070	9/28/2018
2.1.0-rc2	2,782	9/21/2018
2.1.0-rc1	2,868	9/14/2018
2.1.0-beta1	7,819	8/27/2018
2.0.0	90,966	3/28/2018
2.0.0-rc2	6,720	3/13/2018
2.0.0-rc1	7,110	2/26/2018
2.0.0-beta3	4,810	12/21/2017
2.0.0-beta2	2,910	12/11/2017