Microsoft.Orleans.Persistence.Cosmos 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.Cosmos --version 9.2.1
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Persistence.Cosmos" />
                    


                            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.Cosmos --version 9.2.1
                    


                    

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


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

Microsoft Orleans Persistence for Azure Cosmos DB

Introduction

Microsoft Orleans Persistence for Azure Cosmos DB provides grain persistence for Microsoft Orleans using Azure Cosmos DB. This allows your grains to persist their state in Azure Cosmos DB and reload it when they are reactivated, offering a globally distributed, multi-model database service for your Orleans applications.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Persistence.Cosmos

Example - Configuring Azure Cosmos DB Persistence

using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure Azure Cosmos DB as grain storage
            .AddCosmosGrainStorage(
                name: "cosmosStore",
                configureOptions: options =>
                {
                    options.AccountEndpoint = "https://YOUR_COSMOS_ENDPOINT";
                    options.AccountKey = "YOUR_COSMOS_KEY";
                    options.DB = "YOUR_DATABASE_NAME";
                    options.CanCreateResources = true;
                });
    });

// Run the host
await builder.RunAsync();

Example - Using Grain Storage in a Grain

// Define grain state class

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

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

    public MyGrain([PersistentState("state", "cosmosStore")] 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 (1)

Showing the top 1 NuGet packages that depend on Microsoft.Orleans.Persistence.Cosmos:

Package Downloads
Microsoft.AutoGen.RuntimeGateway.Grpc

A programming framework for agentic AI

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Microsoft.Orleans.Persistence.Cosmos:

Repository Stars
dotnet/samples
Sample code referenced by the .NET documentation
microsoft/project-oagents
Experimental AI Agents Framework
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
Version Downloads Last Updated
9.2.1 5,378 7/16/2025
9.2.0 1,200 7/14/2025
9.2.0-preview3 311 6/10/2025
9.2.0-preview2 157 6/4/2025
9.2.0-preview1 137 4/4/2025
9.1.2 31,340 2/13/2025
9.0.1 33,593 11/23/2024
9.0.0 3,973 11/14/2024
8.2.0 62,499 7/12/2024
8.2.0-preview1 163 5/22/2024
8.1.0 18,076 4/17/2024
8.1.0-preview3 155 3/11/2024
8.1.0-preview2 148 2/23/2024
8.1.0-preview1 162 2/13/2024
8.0.0 4,318 1/5/2024
8.0.0-rc2 165 12/20/2023
8.0.0-rc1 163 12/4/2023
7.2.7 180 10/15/2024
7.2.6 8,757 3/9/2024
7.2.5 194 2/22/2024
7.2.4 14,415 12/2/2023
7.2.3 1,122 11/3/2023
7.2.2 1,559 10/16/2023
7.2.1 6,947 7/11/2023
7.2.0 3,239 7/7/2023
3.8.0-preview5 248 5/12/2025
3.8.0-preview4 164 5/6/2025
3.8.0-preview3 192 4/8/2025