Microsoft.Orleans.Reminders.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.Reminders.AzureStorage --version 9.2.1
                    


                    

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


                            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.1
                    


                    

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


                            Install as a Cake Addin
                        

                    

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


                            Install 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.1 18,720 7/16/2025
9.2.0 566 7/14/2025
9.2.0-preview3 443 6/10/2025
9.2.0-preview2 183 6/4/2025
9.2.0-preview1 877 4/4/2025
9.1.2 68,287 2/13/2025
9.0.1 19,950 11/23/2024
9.0.0 2,237 11/14/2024
8.2.0 101,789 7/12/2024
8.2.0-preview1 274 5/22/2024
8.1.0 98,749 4/17/2024
8.1.0-preview3 1,005 3/11/2024
8.1.0-preview2 220 2/23/2024
8.1.0-preview1 1,315 2/13/2024
8.0.0 26,689 1/5/2024
8.0.0-rc2 301 12/20/2023
8.0.0-rc1 281 12/4/2023
7.2.7 395 10/15/2024
7.2.6 4,282 3/9/2024
7.2.5 3,385 2/22/2024
7.2.4 22,721 12/2/2023
7.2.3 13,090 11/3/2023
7.2.2 3,568 10/16/2023
7.2.1 65,708 7/11/2023
7.2.0 2,932 7/7/2023
7.1.2 24,080 4/19/2023
7.1.1 9,480 3/23/2023
7.1.0 15,004 2/1/2023
7.0.0 4,983 11/8/2022
7.0.0-rc2 384 10/19/2022
4.0.0-preview2 4,202 8/4/2022
4.0.0-preview1 2,739 2/10/2022
3.8.0 1,234 5/6/2025
3.8.0-preview5 267 5/12/2025
3.8.0-preview3 238 4/8/2025
3.8.0-preview2 176 4/4/2025
3.8.0-preview1 227 3/31/2025
3.7.2 19,925 5/10/2024
3.7.1 56,376 5/27/2023
3.7.0 12,804 3/23/2023
3.6.5 138,933 8/15/2022
3.6.4 3,635 8/10/2022
3.6.3 2,927 8/4/2022
3.6.2 89,714 4/15/2022
3.6.1 3,961 4/5/2022
3.6.0 47,346 1/20/2022
3.5.1 56,833 11/8/2021
3.5.0 39,497 9/3/2021
3.4.4 1,133 10/4/2021
3.4.3 20,938 6/3/2021
3.4.2 22,121 4/5/2021
3.4.1 14,617 2/3/2021
3.4.0 10,892 1/6/2021
3.4.0-rc1 604 12/9/2020
3.3.0 33,149 9/9/2020
3.3.0-rc2 1,682 9/2/2020
3.3.0-rc1 653 8/19/2020
3.2.2 10,593 7/22/2020
3.2.1 4,899 7/2/2020
3.2.0 5,830 6/4/2020
3.2.0-rc2 855 5/20/2020
3.2.0-rc1 762 5/7/2020
3.1.7 6,116 5/19/2020
3.1.6 15,531 4/16/2020
3.1.5 1,187 4/9/2020
3.1.4 11,801 3/26/2020
3.1.3 1,707 3/16/2020
3.1.2 4,510 3/5/2020
3.1.0 2,636 2/23/2020
3.1.0-rc3 718 2/13/2020
3.1.0-rc2 729 2/12/2020
3.1.0-rc1 779 2/10/2020
3.0.2 23,479 12/12/2019
3.0.1 2,555 11/27/2019
3.0.0 2,979 10/24/2019
3.0.0-rc2 728 10/16/2019
3.0.0-rc1 709 10/9/2019
3.0.0-beta1 724 8/16/2019
2.4.5 11,033 12/29/2019
2.4.4 7,136 11/27/2019
2.4.3 5,505 10/10/2019
2.4.2 7,261 8/31/2019
2.4.1 3,880 8/14/2019
2.4.0 5,497 8/8/2019
2.3.6 24,097 7/24/2019
2.3.5 5,740 6/14/2019
2.3.4 136,036 6/4/2019
2.3.3 2,603 6/2/2019
2.3.2 4,352 5/9/2019
2.3.1 3,249 4/26/2019
2.3.0 37,321 3/20/2019
2.3.0-rc2 2,104 3/13/2019
2.3.0-rc1 1,989 3/4/2019
2.2.4 3,981 2/25/2019
2.2.3 4,058 1/17/2019
2.2.0 11,836 12/13/2018
2.2.0-rc1 2,198 12/4/2018
2.2.0-beta1 2,271 10/21/2018
2.1.2 97,847 10/11/2018
2.1.0 3,949 9/28/2018
2.1.0-rc2 2,726 9/21/2018
2.1.0-rc1 2,761 9/14/2018
2.1.0-beta1 7,561 8/27/2018
2.0.0 83,302 3/28/2018
2.0.0-rc2 6,502 3/13/2018
2.0.0-rc1 4,210 2/26/2018
2.0.0-beta3 4,876 12/21/2017
2.0.0-beta2 3,121 12/11/2017