Microsoft.Orleans.Transactions.AzureStorage 9.2.1

Prefix Reserved
dotnet add package Microsoft.Orleans.Transactions.AzureStorage --version 9.2.1
                    
NuGet\Install-Package Microsoft.Orleans.Transactions.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.Transactions.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.Transactions.AzureStorage" Version="9.2.1" />
                    
Directory.Packages.props
<PackageReference Include="Microsoft.Orleans.Transactions.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.Transactions.AzureStorage --version 9.2.1
                    
#r "nuget: Microsoft.Orleans.Transactions.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.Transactions.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.Transactions.AzureStorage&version=9.2.1
                    
Install as a Cake Addin
#tool nuget:?package=Microsoft.Orleans.Transactions.AzureStorage&version=9.2.1
                    
Install as a Cake Tool

Microsoft Orleans Transactions for Azure Storage

Introduction

Microsoft Orleans Transactions for Azure Storage provides the infrastructure to store Orleans transaction logs in Azure Storage. This package allows Orleans applications to use ACID transactions across multiple grain calls with Azure Storage as the backing transaction log store.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Transactions.AzureStorage

Example - Configuring Azure Storage for Transactions

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

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Enable transactions
            .AddAzureTableTransactionalStateStorage(
                name: "TransactionStore",
                configureOptions: options =>
                {
                    options.ConnectionString = "YOUR_AZURE_STORAGE_CONNECTION_STRING";
                })
            .UseTransactions();
    });

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

Example - Using Transactions in Grains

// A grain with transactional state
public class MyTransactionalGrain : Grain, IMyTransactionalGrain
{
    private readonly ITransactionalState<MyState> _state;

    // Inject the transactional state
    public MyTransactionalGrain(
        [TransactionalState("state", "TransactionStore")]
        ITransactionalState<MyState> state)
    {
        _state = state;
    }

    // Method that performs a transaction
    [Transaction(TransactionOption.Create)]
    public async Task Transfer(string otherGrainKey, int amount)
    {
        // Read our state within the transaction
        var myState = await _state.PerformRead(state => state);
        
        // Ensure we have enough balance
        if (myState.Balance < amount)
            throw new InvalidOperationException("Insufficient funds");
            
        // Update our state within the transaction
        await _state.PerformUpdate(s => s.Balance -= amount);
        
        // Call another grain within the same transaction
        var otherGrain = GrainFactory.GetGrain<IMyTransactionalGrain>(otherGrainKey);
        await otherGrain.Deposit(amount);
    }

    // Method that participates in a transaction
    [Transaction(TransactionOption.Join)]
    public Task Deposit(int amount)
    {
        // Update state within the joined transaction
        return _state.PerformUpdate(s => s.Balance += amount);
    }

    // Read operation within a transaction
    [Transaction(TransactionOption.CreateOrJoin)]
    public Task<int> GetBalance()
    {
        return _state.PerformRead(s => s.Balance);
    }
}

// State class

public class MyState
{
    public int Balance { get; set; }
}

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.Transactions.AzureStorage:

Package Downloads
Microsoft.Orleans.Transactions.TestKit.Base

Testkit base library for transactions

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Microsoft.Orleans.Transactions.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 1,114 7/16/2025
9.2.0 318 7/14/2025
9.2.0-preview3 336 6/10/2025
9.2.0-preview2 181 6/4/2025
9.2.0-preview1 160 4/4/2025
9.1.2 3,595 2/13/2025
9.0.1 1,462 11/23/2024
9.0.0 446 11/14/2024
8.2.0 11,829 7/12/2024
8.2.0-preview1 217 5/22/2024
8.1.0 4,517 4/17/2024
8.1.0-preview3 257 3/11/2024
8.1.0-preview2 240 2/23/2024
8.1.0-preview1 299 2/13/2024
8.0.0 1,315 1/5/2024
8.0.0-rc2 490 12/20/2023
8.0.0-rc1 459 12/4/2023
7.2.7 304 10/15/2024
7.2.6 539 3/9/2024
7.2.5 2,806 2/22/2024
7.2.4 2,152 12/2/2023
7.2.3 754 11/3/2023
7.2.2 3,353 10/16/2023
7.2.1 8,831 7/11/2023
7.2.0 839 7/7/2023
7.1.2 23,049 4/19/2023
7.1.1 1,074 3/23/2023
7.1.0 1,583 2/1/2023
7.0.0 6,096 11/8/2022
7.0.0-rc2 705 10/19/2022
4.0.0-preview2 791 8/4/2022
4.0.0-preview1 1,120 2/10/2022
3.8.0 270 5/6/2025
3.8.0-preview5 282 5/12/2025
3.8.0-preview3 240 4/8/2025
3.8.0-preview2 199 4/4/2025
3.8.0-preview1 257 3/31/2025
3.7.2 353 5/10/2024
3.7.1 16,670 5/27/2023
3.7.0 1,545 3/23/2023
3.6.5 42,252 8/15/2022
3.6.4 1,936 8/10/2022
3.6.3 3,044 8/4/2022
3.6.2 10,959 4/15/2022
3.6.1 2,213 4/5/2022
3.6.0 26,069 1/20/2022
3.5.1 9,246 11/8/2021
3.5.0 14,993 9/3/2021
3.4.4 2,108 10/4/2021
3.4.3 14,591 6/3/2021
3.4.2 9,347 4/5/2021
3.4.1 10,430 2/3/2021
3.4.0 4,567 1/6/2021
3.4.0-rc1 1,366 12/9/2020
3.3.0 12,819 9/9/2020
3.3.0-rc2 1,554 9/2/2020
3.3.0-rc1 1,497 8/19/2020
3.2.2 6,329 7/22/2020
3.2.1 5,552 7/2/2020
3.2.0 3,331 6/4/2020
3.2.0-rc2 1,394 5/20/2020
3.2.0-rc1 1,666 5/7/2020
3.1.7 2,567 5/19/2020
3.1.6 2,628 4/16/2020
3.1.5 2,168 4/9/2020
3.1.4 4,649 3/26/2020
3.1.3 2,699 3/16/2020
3.1.2 2,682 3/5/2020
3.1.0 2,326 2/23/2020
3.1.0-rc3 1,524 2/13/2020
3.1.0-rc2 1,483 2/12/2020
3.1.0-rc1 1,522 2/10/2020
3.0.2 4,276 12/12/2019
3.0.1 3,532 11/27/2019
3.0.0 2,354 10/24/2019
3.0.0-rc2 1,624 10/16/2019
3.0.0-rc1 1,624 10/9/2019
3.0.0-beta1 1,493 8/16/2019
2.4.5 4,919 12/29/2019
2.4.4 2,169 11/27/2019
2.4.3 2,294 10/10/2019
2.4.2 4,271 8/31/2019
2.4.1 2,392 8/14/2019
2.4.0 3,905 8/8/2019
2.3.6 2,902 7/24/2019
2.3.5 2,795 6/14/2019
2.3.4 2,363 6/4/2019
2.3.3 2,300 6/2/2019
2.3.2 2,253 5/9/2019
2.3.1 2,446 4/26/2019
2.3.0 2,740 3/20/2019
2.3.0-rc2 1,511 3/13/2019
2.3.0-rc1 1,656 3/4/2019
2.2.4 1,754 2/25/2019
2.2.3 1,771 1/17/2019
2.2.2 2,389 1/10/2019
2.2.0 1,822 12/13/2018
2.2.0-rc1 1,518 12/4/2018
2.2.0-beta1 1,552 10/21/2018
2.1.2 1,906 10/11/2018
2.1.0 2,098 9/28/2018
2.1.0-rc2 1,768 9/21/2018
2.1.0-rc1 1,645 9/14/2018
2.1.0-beta1 1,680 8/27/2018
2.0.4 2,128 7/20/2018
2.0.0 2,375 3/28/2018
2.0.0-rc2 1,612 3/13/2018
2.0.0-rc1 1,737 2/26/2018
2.0.0-beta3 1,910 12/21/2017
2.0.0-beta2 1,897 12/11/2017