Orleans.Persistence.CosmosDB 1.0.0-preview-1

.NET Standard 2.0
This is a prerelease version of Orleans.Persistence.CosmosDB.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Orleans.Persistence.CosmosDB --version 1.0.0-preview-1
NuGet\Install-Package Orleans.Persistence.CosmosDB -Version 1.0.0-preview-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="Orleans.Persistence.CosmosDB" Version="1.0.0-preview-1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Orleans.Persistence.CosmosDB --version 1.0.0-preview-1
#r "nuget: Orleans.Persistence.CosmosDB, 1.0.0-preview-1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Orleans.Persistence.CosmosDB as a Cake Addin
#addin nuget:?package=Orleans.Persistence.CosmosDB&version=1.0.0-preview-1&prerelease

// Install Orleans.Persistence.CosmosDB as a Cake Tool
#tool nuget:?package=Orleans.Persistence.CosmosDB&version=1.0.0-preview-1&prerelease

<p align="center"> <img src="https://github.com/dotnet/orleans/blob/gh-pages/assets/logo.png" alt="Orleans.CosmosDB" width="300px"> <h1>Orleans CosmosDB Providers</h1> </p>

CircleCI NuGet NuGet NuGet Gitter

Orleans is a framework that provides a straight-forward approach to building distributed high-scale computing applications, without the need to learn and apply complex concurrency or other scaling patterns.

Azure CosmosDB is Microsoft's globally distributed, multi-model database. It is a database for extremely low latency and massively scalable applications anywhere in the world, with native support for NoSQL.

Orleans.CosmosDB is a package that use Azure CosmosDB as a backend for Orleans providers like Cluster Membership, Grain State storage, Streaming and Reminders.


Installation is performed via NuGet

From Package Manager:

PS> Install-Package Orleans.Clustering.CosmosDB -prerelease

PS> Install-Package Orleans.Persistence.CosmosDB -prerelease

PS> Install-Package Orleans.Reminders.CosmosDB -prerelease

.Net CLI:

# dotnet add package Orleans.Clustering.CosmosDB -prerelease

# dotnet add package Orleans.Persistence.CosmosDB -prerelease

# dotnet add package Orleans.Reminders.CosmosDB -prerelease


# paket add Orleans.Clustering.CosmosDB -prerelease

# paket add Orleans.Persistence.CosmosDB -prerelease

# paket add Orleans.Reminders.CosmosDB -prerelease


It is not mandatory to use all the providers at once. Just pick the one you are interested in from the samples and you should be good as they don't depend on each other.


We need to configure the Orleans Silo with the below:

  • Use .UseCosmosDBMembership() on ISiloHostBuilder to enable cluster membership.
  • Use .AddAzureCosmosDBPersistence() on ClusterConfiguration to register the grain state persistence provider.
  • Use .UseAzureCosmosDBPersistence() on ISiloHostBuilder to configure the grain state persistence provider.
  • Use .AddAzureCosmosDBReminders() on ClusterConfiguration to register the reminders provider.
  • Use .UseAzureCosmosDBReminders() on ISiloHostBuilder to configure the reminders provider.


var siloConfig = new ClusterConfiguration();
siloConfig.AddAzureCosmosDBPersistence("myProvider"); //Register the persistence provider.
siloConfig.AddAzureCosmosDBReminders(); // Register the reminders provider.

var silo = new SiloHostBuilder()
    .UseCosmosDBMembership() // Use CosmosDB as the cluster membership table.
    .UseAzureCosmosDBPersistence() // Configure CosmosDB persistence provider.
    .UseAzureCosmosDBReminders() // Configure CosmosDB reminders provider.
await silo.StartAsync();


Now your client application needs to connect to the Orleans Cluster by using configuring the Gateway List Provider:

  • Use .UseCosmosDBGatewayListProvider() on IClientBuilder.


var clientConfig = new ClientConfiguration();

var client = new ClientBuilder()
    .UseCosmosDBGatewayListProvider() // Use CosmosDB as the Gateway list provider.
    await client.Connect();

Great! Now you have Orleans configured to use Azure CosmosDB as the back storage for its providers!


PRs and feedback are very welcome!

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

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

Package Downloads

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.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.3 28,930 4/24/2020
3.0.2 4,807 3/23/2020
3.0.1 1,413 1/29/2020
3.0.0 522 11/14/2019
1.3.0 2,207 4/3/2019
1.2.1 1,224 3/20/2019
1.2.0 603 3/19/2019
1.1.42 1,689 9/28/2018
1.1.40 1,202 3/28/2018
1.1.38 881 3/28/2018
1.1.0-rc2-36 686 3/13/2018
1.1.0-rc1-34 717 3/12/2018
1.1.0-rc1-29 652 2/27/2018
1.0.1-preview-27 726 2/10/2018
1.0.1-preview-25 758 2/5/2018
1.0.1-preview-21 603 2/1/2018
1.0.1-preview-19 712 2/1/2018
1.0.0-preview-17 611 2/1/2018
1.0.0-preview-16 714 2/1/2018
1.0.0-preview-1 898 2/1/2018