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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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

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

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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Azure.Core (>= 1.46.2)
- Azure.Data.Tables (>= 12.9.1)
- Microsoft.AspNetCore.Connections.Abstractions (>= 8.0.11)
- Microsoft.CodeAnalysis.Analyzers (>= 3.11.0)
- Microsoft.CodeAnalysis.Common (>= 4.5.0)
- Microsoft.CodeAnalysis.Workspaces.Common (>= 4.5.0)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Json (>= 8.0.1)
- Microsoft.Extensions.DependencyInjection (>= 8.0.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.DependencyModel (>= 8.0.2)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Logging (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Logging.Console (>= 8.0.1)
- Microsoft.Extensions.Logging.Debug (>= 8.0.1)
- Microsoft.Extensions.ObjectPool (>= 8.0.11)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
- Microsoft.Orleans.Analyzers (>= 9.2.1)
- Microsoft.Orleans.CodeGenerator (>= 9.2.1)
- Microsoft.Orleans.Transactions (>= 9.2.1)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 8.0.0)
- System.IO.Hashing (>= 8.0.0)
- System.IO.Pipelines (>= 8.0.0)
- System.Memory.Data (>= 8.0.1)
- System.Text.Json (>= 8.0.5)

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	118.4K

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.	3.5K

Version	Downloads	Last Updated
9.2.1	730	7/16/2025
9.2.0	245	7/14/2025
9.2.0-preview3	324	6/10/2025
9.2.0-preview2	170	6/4/2025
9.2.0-preview1	150	4/4/2025
9.1.2	3,392	2/13/2025
9.0.1	1,410	11/23/2024
9.0.0	398	11/14/2024
8.2.0	11,745	7/12/2024
8.2.0-preview1	210	5/22/2024
8.1.0	4,465	4/17/2024
8.1.0-preview3	244	3/11/2024
8.1.0-preview2	231	2/23/2024
8.1.0-preview1	293	2/13/2024
8.0.0	1,272	1/5/2024
8.0.0-rc2	484	12/20/2023
8.0.0-rc1	454	12/4/2023
7.2.7	256	10/15/2024
7.2.6	483	3/9/2024
7.2.5	2,586	2/22/2024
7.2.4	2,102	12/2/2023
7.2.3	705	11/3/2023
7.2.2	3,306	10/16/2023
7.2.1	8,678	7/11/2023
7.2.0	803	7/7/2023
7.1.2	23,011	4/19/2023
7.1.1	1,044	3/23/2023
7.1.0	1,544	2/1/2023
7.0.0	6,064	11/8/2022
7.0.0-rc2	691	10/19/2022
4.0.0-preview2	774	8/4/2022
4.0.0-preview1	1,098	2/10/2022
3.8.0	227	5/6/2025
3.8.0-preview5	263	5/12/2025
3.8.0-preview3	228	4/8/2025
3.8.0-preview2	186	4/4/2025
3.8.0-preview1	238	3/31/2025
3.7.2	308	5/10/2024
3.7.1	16,631	5/27/2023
3.7.0	1,501	3/23/2023
3.6.5	42,201	8/15/2022
3.6.4	1,898	8/10/2022
3.6.3	3,000	8/4/2022
3.6.2	10,923	4/15/2022
3.6.1	2,176	4/5/2022
3.6.0	26,034	1/20/2022
3.5.1	9,209	11/8/2021
3.5.0	14,952	9/3/2021
3.4.4	2,058	10/4/2021
3.4.3	14,546	6/3/2021
3.4.2	9,306	4/5/2021
3.4.1	10,403	2/3/2021
3.4.0	4,548	1/6/2021
3.4.0-rc1	1,348	12/9/2020
3.3.0	12,801	9/9/2020
3.3.0-rc2	1,547	9/2/2020
3.3.0-rc1	1,479	8/19/2020
3.2.2	6,300	7/22/2020
3.2.1	5,543	7/2/2020
3.2.0	3,307	6/4/2020
3.2.0-rc2	1,375	5/20/2020
3.2.0-rc1	1,650	5/7/2020
3.1.7	2,557	5/19/2020
3.1.6	2,601	4/16/2020
3.1.5	2,148	4/9/2020
3.1.4	4,636	3/26/2020
3.1.3	2,681	3/16/2020
3.1.2	2,640	3/5/2020
3.1.0	2,304	2/23/2020
3.1.0-rc3	1,514	2/13/2020
3.1.0-rc2	1,468	2/12/2020
3.1.0-rc1	1,506	2/10/2020
3.0.2	4,258	12/12/2019
3.0.1	3,504	11/27/2019
3.0.0	2,329	10/24/2019
3.0.0-rc2	1,593	10/16/2019
3.0.0-rc1	1,605	10/9/2019
3.0.0-beta1	1,472	8/16/2019
2.4.5	4,891	12/29/2019
2.4.4	2,150	11/27/2019
2.4.3	2,277	10/10/2019
2.4.2	4,242	8/31/2019
2.4.1	2,373	8/14/2019
2.4.0	3,892	8/8/2019
2.3.6	2,888	7/24/2019
2.3.5	2,772	6/14/2019
2.3.4	2,345	6/4/2019
2.3.3	2,289	6/2/2019
2.3.2	2,232	5/9/2019
2.3.1	2,434	4/26/2019
2.3.0	2,705	3/20/2019
2.3.0-rc2	1,504	3/13/2019
2.3.0-rc1	1,632	3/4/2019
2.2.4	1,742	2/25/2019
2.2.3	1,757	1/17/2019
2.2.2	2,382	1/10/2019
2.2.0	1,809	12/13/2018
2.2.0-rc1	1,503	12/4/2018
2.2.0-beta1	1,538	10/21/2018
2.1.2	1,890	10/11/2018
2.1.0	2,078	9/28/2018
2.1.0-rc2	1,749	9/21/2018
2.1.0-rc1	1,624	9/14/2018
2.1.0-beta1	1,659	8/27/2018
2.0.4	2,112	7/20/2018
2.0.0	2,345	3/28/2018
2.0.0-rc2	1,591	3/13/2018
2.0.0-rc1	1,719	2/26/2018
2.0.0-beta3	1,889	12/21/2017
2.0.0-beta2	1,875	12/11/2017