Microsoft.Orleans.Persistence.AzureStorage 9.2.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Microsoft.Orleans.Persistence.AzureStorage --version 9.2.1
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Persistence.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.Persistence.AzureStorage --version 9.2.1
                    


                    

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


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

Microsoft Orleans Persistence for Azure Storage

Introduction

Microsoft Orleans Persistence for Azure Storage provides grain persistence for Microsoft Orleans using Azure Storage (Blob and Table). This allows your grains to persist their state in Azure Storage and reload it when they are reactivated.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Persistence.AzureStorage

Example - Configuring Azure Storage Persistence

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

// Define grain interface
public interface IMyGrain : IGrainWithStringKey
{
    Task SetData(string data);
    Task<string> GetData();
}


var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure Azure Table Storage as grain storage
            .AddAzureTableGrainStorage(
                name: "tableStore",
                configureOptions: options =>
                {
                    options.ConnectionString = "YOUR_AZURE_STORAGE_CONNECTION_STRING";
                })
            // Configure Azure Blob Storage as grain storage
            .AddAzureBlobGrainStorage(
                name: "blobStore",
                configureOptions: options =>
                {
                    options.ConnectionString = "YOUR_AZURE_STORAGE_CONNECTION_STRING";
                });
    });

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<IMyGrain>("user123");
await grain.SetData("Hello from Azure Storage!");
var response = await grain.GetData();

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

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

Example - Using Grain Storage in a Grain

using System;
using System.Threading.Tasks;
using Orleans;
using Orleans.Runtime;
namespace ExampleGrains;

// Define grain state class

public class MyGrainState
{
    public string Data { get; set; }
    public int Version { get; set; }
}

// Grain implementation that uses the Azure storage
public class MyGrain : Grain, IMyGrain, IGrainWithStringKey
{
    private readonly IPersistentState<MyGrainState> _state;

    public MyGrain([PersistentState("state", "tableStore")] IPersistentState<MyGrainState> state)
    {
        _state = state;
    }

    public async Task SetData(string data)
    {
        _state.State.Data = data;
        _state.State.Version++;
        await _state.WriteStateAsync();
    }

    public Task<string> GetData()
    {
        return Task.FromResult(_state.State.Data);
    }
}

Documentation

For more comprehensive documentation, please refer to:

Feedback & Contributing

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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (6)

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

Package Downloads
Blauhaus.Orleans

Package Description
Blauhaus.EVACS.Orleans

Package Description
Microsoft.Orleans.OrleansAzureUtils

Support library for hosting Orleans on Microsoft Azure.
Orleans.Contrib.UniversalSilo

This library provides primitives to set up a configurable, application-agnostic Orleans silo and clients. Use it with the Orleans.Contrib.UniversalSilo.Templates to get started with Orleans.
Nabs.Launchpad.Core.Silo

Package Description

GitHub repositories (7)

Showing the top 7 popular GitHub repositories that depend on Microsoft.Orleans.Persistence.AzureStorage:

Repository Stars
dotnet/aspire
Aspire is the tool for code-first, extensible, observable dev and deploy.
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.
microsoft/dotnet-podcasts
.NET reference application shown at .NET Conf featuring ASP.NET Core, Blazor, .NET MAUI, Microservices, Orleans, Playwright, and more!
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
Samsung/Tizen.NET
Welcome to Tizen .NET
ReubenBond/hanbaobao-web
Orleans sample application with Kubernetes hosting
Version Downloads Last Updated
9.2.1 91,680 7/16/2025
9.2.0 1,928 7/14/2025
9.2.0-preview3 720 6/10/2025
9.2.0-preview2 218 6/4/2025
9.2.0-preview1 5,899 4/4/2025
9.1.2 133,444 2/13/2025
9.0.1 38,527 11/23/2024
9.0.0 3,782 11/14/2024
8.2.0 157,435 7/12/2024
8.2.0-preview1 362 5/22/2024
8.1.0 119,687 4/17/2024
8.1.0-preview3 1,145 3/11/2024
8.1.0-preview2 255 2/23/2024
8.1.0-preview1 1,381 2/13/2024
8.0.0 50,905 1/5/2024
8.0.0-rc2 395 12/20/2023
8.0.0-rc1 395 12/4/2023
7.2.7 5,911 10/15/2024
7.2.6 11,631 3/9/2024
7.2.5 7,581 2/22/2024
7.2.4 29,615 12/2/2023
7.2.3 17,264 11/3/2023
7.2.2 9,863 10/16/2023
7.2.1 78,278 7/11/2023
7.2.0 3,203 7/7/2023
7.1.2 37,696 4/19/2023
7.1.1 20,075 3/23/2023
7.1.0 36,217 2/1/2023
7.0.0 19,780 11/8/2022
7.0.0-rc2 695 10/19/2022
4.0.0-preview2 4,191 8/4/2022
4.0.0-preview1 2,651 2/10/2022
3.8.0 2,443 5/6/2025
3.8.0-preview5 307 5/12/2025
3.8.0-preview3 266 4/8/2025
3.8.0-preview2 221 4/4/2025
3.8.0-preview1 256 3/31/2025
3.7.2 20,862 5/10/2024
3.7.1 69,572 5/27/2023
3.7.0 84,158 3/23/2023
3.6.5 614,251 8/15/2022
3.6.4 18,089 8/10/2022
3.6.3 40,743 8/4/2022
3.6.2 597,986 4/15/2022
3.6.1 20,524 4/5/2022
3.6.0 111,913 1/20/2022
3.5.1 93,358 11/8/2021
3.5.0 90,640 9/3/2021
3.4.4 2,090 10/4/2021
3.4.3 62,925 6/3/2021
3.4.2 50,159 4/5/2021
3.4.1 42,716 2/3/2021
3.4.0 16,672 1/6/2021
3.4.0-rc1 694 12/9/2020
3.3.0 37,799 9/9/2020
3.3.0-rc2 1,728 9/2/2020
3.3.0-rc1 721 8/19/2020
3.2.2 11,630 7/22/2020
3.2.1 5,173 7/2/2020
3.2.0 7,067 6/4/2020
3.2.0-rc2 899 5/20/2020
3.2.0-rc1 904 5/7/2020
3.1.7 6,324 5/19/2020
3.1.6 19,713 4/16/2020
3.1.5 1,312 4/9/2020
3.1.4 18,597 3/26/2020
3.1.3 6,139 3/16/2020
3.1.2 4,489 3/5/2020
3.1.0 2,935 2/23/2020
3.1.0-rc3 779 2/13/2020
3.1.0-rc2 799 2/12/2020
3.1.0-rc1 780 2/10/2020
3.0.2 19,316 12/12/2019
3.0.1 3,024 11/27/2019
3.0.0 8,047 10/24/2019
3.0.0-rc2 811 10/16/2019
3.0.0-rc1 827 10/9/2019
3.0.0-beta1 1,183 8/16/2019
2.4.5 5,928 12/29/2019
2.4.4 12,545 11/27/2019
2.4.3 12,736 10/10/2019
2.4.2 8,296 8/31/2019
2.4.1 4,856 8/14/2019
2.4.0 5,304 8/8/2019
2.3.6 24,339 7/24/2019
2.3.5 15,501 6/14/2019
2.3.4 3,920 6/4/2019
2.3.3 2,700 6/2/2019
2.3.2 4,452 5/9/2019
2.3.1 3,381 4/26/2019
2.3.0 10,630 3/20/2019
2.3.0-rc2 2,234 3/13/2019
2.3.0-rc1 2,150 3/4/2019
2.2.4 4,447 2/25/2019
2.2.3 4,375 1/17/2019
2.2.0 9,896 12/13/2018
2.2.0-rc1 2,310 12/4/2018
2.2.0-beta1 2,495 10/21/2018
2.1.2 15,276 10/11/2018
2.1.0 4,515 9/28/2018
2.1.0-rc2 2,900 9/21/2018
2.1.0-rc1 2,808 9/14/2018
2.1.0-beta1 7,683 8/27/2018
2.0.3 9,020 6/15/2018
2.0.0 16,132 3/28/2018
2.0.0-rc2 3,410 3/13/2018
2.0.0-rc1 4,417 2/26/2018
2.0.0-beta3 4,871 12/21/2017
2.0.0-beta2 3,335 12/11/2017