Microsoft.Orleans.Reminders.AzureStorage 9.2.0-preview3

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.Orleans.Reminders.AzureStorage. 
dotnet add package Microsoft.Orleans.Reminders.AzureStorage --version 9.2.0-preview3
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Reminders.AzureStorage -Version 9.2.0-preview3
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.Reminders.AzureStorage" Version="9.2.0-preview3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.Orleans.Reminders.AzureStorage" Version="9.2.0-preview3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Reminders.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.Reminders.AzureStorage --version 9.2.0-preview3
                    


                    

                
#r "nuget: Microsoft.Orleans.Reminders.AzureStorage, 9.2.0-preview3"
#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. 
#addin nuget:?package=Microsoft.Orleans.Reminders.AzureStorage&version=9.2.0-preview3&prerelease
                    


                            Install Microsoft.Orleans.Reminders.AzureStorage as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Orleans.Reminders.AzureStorage&version=9.2.0-preview3&prerelease
                    


                            Install Microsoft.Orleans.Reminders.AzureStorage as a Cake Tool

Microsoft Orleans Reminders for Azure Storage

Introduction

Microsoft Orleans Reminders for Azure Storage provides persistence for Orleans reminders using Azure Table Storage. This allows your Orleans applications to schedule persistent reminders that will be triggered even after silo restarts or grain deactivation.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Reminders.AzureStorage

Example - Configuring Azure Storage Reminders

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

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure Azure Table Storage as reminder storage
            .UseAzureTableReminderService(options =>
            {
                options.ConnectionString = "YOUR_AZURE_STORAGE_CONNECTION_STRING";
                options.TableName = "OrleansReminders";
            });
    });

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

Example - Using Reminders in a Grain

public interface IReminderGrain
{
    Task StartReminder(string reminderName);
    Task StopReminder();
}

public class ReminderGrain : Grain, IReminderGrain, IRemindable
{
    private string _reminderName = "MyReminder";

    public async Task StartReminder(string reminderName)
    {
        _reminderName = reminderName;
        
        // Register a persistent reminder
        await RegisterOrUpdateReminder(
            reminderName,
            TimeSpan.FromMinutes(2),  // Time to delay before the first tick (must be > 1 minute)
            TimeSpan.FromMinutes(5)); // Period of the reminder (must be > 1 minute)
    }

    public async Task StopReminder()
    {
        // Find and unregister the reminder
        var reminder = await GetReminder(_reminderName);
        if (reminder != null)
        {
            await UnregisterReminder(reminder);
        }
    }

    public Task ReceiveReminder(string reminderName, TickStatus status)
    {
        // This method is called when the reminder ticks
        Console.WriteLine($"Reminder {reminderName} triggered at {DateTime.UtcNow}. Status: {status}");
        return Task.CompletedTask;
    }
}

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

Showing the top 4 NuGet packages that depend on Microsoft.Orleans.Reminders.AzureStorage:

Package Downloads
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.
Troolio.Core

Package Description
Microsoft.Orleans.Persistence.AzureStorage.Migration

Microsoft Orleans persistence migration providers for Azure Storage

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.Orleans.Reminders.AzureStorage:

Repository Stars
Dotnet-Boxed/Templates
.NET project templates with batteries included, providing the minimum amount of code required to get you going faster.
Version Downloads Last updated
9.2.0-preview3 288 6/10/2025
9.2.0-preview2 135 6/4/2025
9.2.0-preview1 790 4/4/2025
9.1.2 38,932 2/13/2025
9.0.1 18,516 11/23/2024
9.0.0 1,993 11/14/2024
8.2.0 87,125 7/12/2024
8.2.0-preview1 235 5/22/2024
8.1.0 92,225 4/17/2024
8.1.0-preview3 950 3/11/2024
8.1.0-preview2 171 2/23/2024
8.1.0-preview1 1,272 2/13/2024
8.0.0 26,050 1/5/2024
8.0.0-rc2 264 12/20/2023
8.0.0-rc1 241 12/4/2023
7.2.7 215 10/15/2024
7.2.6 4,090 3/9/2024
7.2.5 3,251 2/22/2024
7.2.4 21,910 12/2/2023
7.2.3 12,849 11/3/2023
7.2.2 3,438 10/16/2023
7.2.1 65,134 7/11/2023
7.2.0 2,807 7/7/2023
7.1.2 23,934 4/19/2023
7.1.1 9,359 3/23/2023
7.1.0 14,481 2/1/2023
7.0.0 4,849 11/8/2022
7.0.0-rc2 308 10/19/2022
4.0.0-preview2 4,124 8/4/2022
4.0.0-preview1 2,647 2/10/2022
3.8.0 453 5/6/2025
3.8.0-preview5 214 5/12/2025
3.8.0-preview3 192 4/8/2025
3.8.0-preview2 132 4/4/2025
3.8.0-preview1 174 3/31/2025
3.7.2 16,214 5/10/2024
3.7.1 52,418 5/27/2023
3.7.0 12,596 3/23/2023
3.6.5 128,489 8/15/2022
3.6.4 3,489 8/10/2022
3.6.3 2,782 8/4/2022
3.6.2 87,915 4/15/2022
3.6.1 3,457 4/5/2022
3.6.0 47,137 1/20/2022
3.5.1 54,630 11/8/2021
3.5.0 38,965 9/3/2021
3.4.4 987 10/4/2021
3.4.3 20,807 6/3/2021
3.4.2 21,979 4/5/2021
3.4.1 14,498 2/3/2021
3.4.0 10,807 1/6/2021
3.4.0-rc1 531 12/9/2020
3.3.0 32,871 9/9/2020
3.3.0-rc2 1,614 9/2/2020
3.3.0-rc1 562 8/19/2020
3.2.2 10,488 7/22/2020
3.2.1 4,793 7/2/2020
3.2.0 5,718 6/4/2020
3.2.0-rc2 750 5/20/2020
3.2.0-rc1 681 5/7/2020
3.1.7 6,042 5/19/2020
3.1.6 15,323 4/16/2020
3.1.5 1,088 4/9/2020
3.1.4 11,659 3/26/2020
3.1.3 1,604 3/16/2020
3.1.2 4,419 3/5/2020
3.1.0 2,546 2/23/2020
3.1.0-rc3 614 2/13/2020
3.1.0-rc2 623 2/12/2020
3.1.0-rc1 686 2/10/2020
3.0.2 23,388 12/12/2019
3.0.1 2,458 11/27/2019
3.0.0 2,845 10/24/2019
3.0.0-rc2 611 10/16/2019
3.0.0-rc1 611 10/9/2019
3.0.0-beta1 632 8/16/2019
2.4.5 10,799 12/29/2019
2.4.4 7,028 11/27/2019
2.4.3 5,369 10/10/2019
2.4.2 7,165 8/31/2019
2.4.1 3,745 8/14/2019
2.4.0 5,302 8/8/2019
2.3.6 23,970 7/24/2019
2.3.5 5,600 6/14/2019
2.3.4 135,919 6/4/2019
2.3.3 2,507 6/2/2019
2.3.2 4,245 5/9/2019
2.3.1 3,104 4/26/2019
2.3.0 37,203 3/20/2019
2.3.0-rc2 2,016 3/13/2019
2.3.0-rc1 1,865 3/4/2019
2.2.4 3,855 2/25/2019
2.2.3 3,949 1/17/2019
2.2.0 11,733 12/13/2018
2.2.0-rc1 2,075 12/4/2018
2.2.0-beta1 2,162 10/21/2018
2.1.2 97,698 10/11/2018
2.1.0 3,780 9/28/2018
2.1.0-rc2 2,596 9/21/2018
2.1.0-rc1 2,613 9/14/2018
2.1.0-beta1 7,397 8/27/2018
2.0.0 82,977 3/28/2018
2.0.0-rc2 6,334 3/13/2018
2.0.0-rc1 4,030 2/26/2018
2.0.0-beta3 4,670 12/21/2017
2.0.0-beta2 2,917 12/11/2017