Microsoft.Orleans.Reminders.AzureStorage 9.2.0-preview2
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
- If you have any issues or would like to provide feedback, please open an issue on GitHub
- Join our community on Discord
- Follow the @msftorleans Twitter account for Orleans announcements
- Contributions are welcome! Please review our contribution guidelines
- This project is licensed under the MIT license
Showing the top 20 packages that depend on Microsoft.Orleans.Reminders.AzureStorage.
| Packages | Downloads |
|---|---|
|
Microsoft.Orleans.OrleansAzureUtils
Support library for hosting Orleans on Microsoft Azure.
|
2 |
|
Microsoft.Orleans.OrleansAzureUtils
Support library for hosting Orleans on Microsoft Azure.
|
1 |
.NET 8.0
- Microsoft.Orleans.Analyzers (>= 9.2.0-preview2)
- System.Text.Json (>= 8.0.5)
- System.Memory.Data (>= 8.0.1)
- System.IO.Pipelines (>= 8.0.0)
- System.IO.Hashing (>= 8.0.0)
- System.Collections.Immutable (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.3)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.ObjectPool (>= 8.0.11)
- Microsoft.Extensions.Logging.Debug (>= 8.0.1)
- Microsoft.Extensions.Logging.Console (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Logging (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.DependencyModel (>= 8.0.2)
- Microsoft.CodeAnalysis.Analyzers (>= 3.11.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.1)
- Microsoft.Extensions.Configuration.Json (>= 8.0.1)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.CodeAnalysis.Workspaces.Common (>= 4.5.0)
- Microsoft.CodeAnalysis.Common (>= 4.5.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.AspNetCore.Connections.Abstractions (>= 8.0.11)
- System.Net.NameResolution (>= 4.3.0)
- Azure.Data.Tables (>= 12.9.1)
- Azure.Core (>= 1.44.1)
- Microsoft.Orleans.Runtime (>= 9.2.0-preview2)
- Microsoft.Orleans.Reminders (>= 9.2.0-preview2)
- Microsoft.Orleans.CodeGenerator (>= 9.2.0-preview2)
| Version | Downloads | Last updated |
|---|---|---|
| 9.2.0-preview3 | 0 | 6/10/2025 |
| 9.2.0-preview2 | 3 | 6/7/2025 |
| 9.2.0-preview1 | 1 | 6/8/2025 |
| 9.1.2 | 1 | 6/9/2025 |
| 9.0.1 | 1 | 6/9/2025 |
| 9.0.0 | 1 | 6/9/2025 |
| 8.2.0 | 1 | 6/9/2025 |
| 8.2.0-preview1 | 1 | 6/9/2025 |
| 8.1.0 | 1 | 6/9/2025 |
| 8.1.0-preview3 | 1 | 6/9/2025 |
| 8.1.0-preview2 | 1 | 6/9/2025 |
| 8.1.0-preview1 | 1 | 6/9/2025 |
| 8.0.0 | 1 | 6/9/2025 |
| 8.0.0-rc2 | 1 | 6/9/2025 |
| 8.0.0-rc1 | 1 | 6/9/2025 |
| 7.2.7 | 1 | 6/9/2025 |
| 7.2.6 | 1 | 6/9/2025 |
| 7.2.5 | 1 | 6/9/2025 |
| 7.2.4 | 1 | 6/9/2025 |
| 7.2.3 | 1 | 6/9/2025 |
| 7.2.2 | 2 | 6/7/2025 |
| 7.2.1 | 1 | 6/10/2025 |
| 7.2.0 | 1 | 6/9/2025 |
| 7.1.2 | 1 | 6/9/2025 |
| 7.1.1 | 1 | 6/9/2025 |
| 7.1.0 | 1 | 6/9/2025 |
| 7.0.0 | 1 | 6/9/2025 |
| 7.0.0-rc2 | 1 | 6/9/2025 |
| 4.0.0-preview2 | 1 | 6/9/2025 |
| 4.0.0-preview1 | 1 | 6/9/2025 |
| 3.8.0 | 0 | 5/6/2025 |
| 3.8.0-preview5 | 0 | 5/12/2025 |
| 3.8.0-preview3 | 1 | 6/9/2025 |
| 3.8.0-preview2 | 1 | 6/9/2025 |
| 3.8.0-preview1 | 1 | 6/9/2025 |
| 3.7.2 | 1 | 6/9/2025 |
| 3.7.1 | 1 | 6/9/2025 |
| 3.7.0 | 1 | 6/9/2025 |
| 3.6.5 | 1 | 6/9/2025 |
| 3.6.4 | 1 | 6/9/2025 |
| 3.6.3 | 1 | 6/9/2025 |
| 3.6.2 | 1 | 6/9/2025 |
| 3.6.1 | 1 | 6/9/2025 |
| 3.6.0 | 2 | 6/8/2025 |
| 3.5.1 | 1 | 6/9/2025 |
| 3.5.0 | 1 | 6/9/2025 |
| 3.4.4 | 1 | 6/9/2025 |
| 3.4.3 | 0 | 6/3/2021 |
| 3.4.2 | 1 | 6/9/2025 |
| 3.4.1 | 1 | 6/9/2025 |
| 3.4.0 | 1 | 6/9/2025 |
| 3.4.0-rc1 | 1 | 6/9/2025 |
| 3.3.0 | 1 | 6/9/2025 |
| 3.3.0-rc2 | 1 | 6/9/2025 |
| 3.3.0-rc1 | 1 | 6/9/2025 |
| 3.2.2 | 1 | 6/9/2025 |
| 3.2.1 | 1 | 6/9/2025 |
| 3.2.0 | 1 | 6/9/2025 |
| 3.2.0-rc2 | 1 | 6/9/2025 |
| 3.2.0-rc1 | 1 | 6/9/2025 |
| 3.1.7 | 1 | 6/9/2025 |
| 3.1.6 | 1 | 6/9/2025 |
| 3.1.5 | 1 | 6/9/2025 |
| 3.1.4 | 1 | 6/9/2025 |
| 3.1.3 | 1 | 6/9/2025 |
| 3.1.2 | 2 | 6/9/2025 |
| 3.1.0 | 2 | 6/9/2025 |
| 3.1.0-rc3 | 1 | 6/9/2025 |
| 3.1.0-rc2 | 1 | 6/9/2025 |
| 3.1.0-rc1 | 1 | 6/9/2025 |
| 3.0.2 | 1 | 6/9/2025 |
| 3.0.1 | 1 | 6/9/2025 |
| 3.0.0 | 1 | 6/9/2025 |
| 3.0.0-rc2 | 1 | 6/9/2025 |
| 3.0.0-rc1 | 1 | 6/9/2025 |
| 3.0.0-beta1 | 1 | 6/9/2025 |
| 2.4.5 | 1 | 6/9/2025 |
| 2.4.4 | 1 | 6/9/2025 |
| 2.4.3 | 1 | 6/10/2025 |
| 2.4.2 | 1 | 6/9/2025 |
| 2.4.1 | 1 | 6/9/2025 |
| 2.4.0 | 1 | 6/9/2025 |
| 2.3.6 | 1 | 6/9/2025 |
| 2.3.5 | 1 | 6/9/2025 |
| 2.3.4 | 1 | 6/9/2025 |
| 2.3.3 | 1 | 6/9/2025 |
| 2.3.2 | 1 | 6/10/2025 |
| 2.3.1 | 1 | 6/9/2025 |
| 2.3.0 | 1 | 6/9/2025 |
| 2.3.0-rc2 | 1 | 6/9/2025 |
| 2.3.0-rc1 | 1 | 6/9/2025 |
| 2.2.4 | 1 | 6/9/2025 |
| 2.2.3 | 1 | 6/9/2025 |
| 2.2.0 | 2 | 6/9/2025 |
| 2.2.0-rc1 | 1 | 6/9/2025 |
| 2.2.0-beta1 | 1 | 6/9/2025 |
| 2.1.2 | 1 | 6/9/2025 |
| 2.1.0 | 1 | 6/9/2025 |
| 2.1.0-rc2 | 2 | 6/9/2025 |
| 2.1.0-rc1 | 1 | 6/9/2025 |
| 2.1.0-beta1 | 1 | 6/9/2025 |
| 2.0.0 | 1 | 6/9/2025 |
| 2.0.0-rc2 | 1 | 6/9/2025 |
| 2.0.0-rc1 | 1 | 6/9/2025 |
| 2.0.0-beta3 | 1 | 6/9/2025 |
| 2.0.0-beta2 | 1 | 6/9/2025 |