Aspire.Hosting.Azure.Redis 13.1.0

Prefix Reserved

dotnet add package Aspire.Hosting.Azure.Redis --version 13.1.0

NuGet\Install-Package Aspire.Hosting.Azure.Redis -Version 13.1.0

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="Aspire.Hosting.Azure.Redis" Version="13.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Aspire.Hosting.Azure.Redis" Version="13.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Aspire.Hosting.Azure.Redis" />
                    

                            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 Aspire.Hosting.Azure.Redis --version 13.1.0

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

#r "nuget: Aspire.Hosting.Azure.Redis, 13.1.0"

#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 Aspire.Hosting.Azure.Redis@13.1.0

#: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=Aspire.Hosting.Azure.Redis&version=13.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Hosting.Azure.Redis&version=13.1.0
                    

                            Install as a Cake Tool

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

Aspire.Hosting.Azure.Redis library

Provides extension methods and resource definitions for an Aspire AppHost to configure Azure Managed Redis.

Note: The AddAzureRedis method is obsolete. Use AddAzureManagedRedis instead, which provisions Azure Managed Redis. Azure Cache for Redis announced its retirement timeline.

Getting started

Prerequisites

Azure subscription - create one for free

Install the package

In your AppHost project, install the Aspire.Hosting.Azure.Redis library with NuGet:

dotnet add package Aspire.Hosting.Azure.Redis

Configure Azure Provisioning for local development

Adding Azure resources to the Aspire application model will automatically enable development-time provisioning for Azure resources so that you don't need to configure them manually. Provisioning requires a number of settings to be available via .NET configuration. Set these values in user secrets in order to allow resources to be configured automatically.

{
    "Azure": {
      "SubscriptionId": "<your subscription id>",
      "ResourceGroupPrefix": "<prefix for the resource group>",
      "Location": "<azure location>"
    }
}

NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.

Usage example

Then, in the AppHost.cs file of AppHost, register an Azure Managed Redis resource using the following methods:

var redis = builder.AddAzureManagedRedis("cache");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(redis);

The WithReference method configures a connection in the MyService project named cache. By default, AddAzureManagedRedis configures Microsoft Entra ID authentication. This requires changes to applications that need to connect to these resources. In the Program.cs file of MyService, the redis connection can be consumed using the client library Aspire.Microsoft.Azure.StackExchangeRedis:

builder.AddRedisClientBuilder("cache")
       .WithAzureAuthentication();

Connection Properties

When you reference Azure Redis resources using WithReference, the following connection properties are made available to the consuming project:

Azure Redis Enterprise

Property Name	Description
`Host`	The hostname of the Azure Redis Enterprise database endpoint.
`Port`	The port of the Azure Redis Enterprise database endpoint (10000 for Azure).
`Uri`	The Redis connection URI. In Azure mode this is `redis://{Host}`; when running via `RunAsContainer` it matches `redis://[:{Password}@]{Host}:{Port}`.
`Password`	The access key for the Redis server. Empty when using Entra ID authentication; populated when using `WithAccessKeyAuthentication()` or running as a container.

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called cache becomes CACHE_URI.

Additional documentation

Feedback & contributing

https://github.com/dotnet/aspire

*Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd.

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
- Aspire.Hosting.Azure (>= 13.1.0)
- Aspire.Hosting.Azure.KeyVault (>= 13.1.0)
- Aspire.Hosting.Redis (>= 13.1.0)
- AspNetCore.HealthChecks.Redis (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.50.0)
- Azure.Identity (>= 1.17.0)
- Azure.Provisioning (>= 1.4.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.Redis (>= 1.1.0)
- Azure.Provisioning.RedisEnterprise (>= 1.1.0)
- Azure.ResourceManager.Authorization (>= 1.1.6)
- Azure.ResourceManager.KeyVault (>= 1.3.3)
- Azure.ResourceManager.Resources (>= 1.11.1)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Google.Protobuf (>= 3.33.0)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.Tools (>= 2.72.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 18.0.5)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.4)
- Polly.Core (>= 8.6.4)
- Semver (>= 3.0.0)
- StackExchange.Redis (>= 2.9.32)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 9.0.10)

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Aspire.Hosting.Azure.Redis:

Package	Downloads
CommunityToolkit.Aspire.Hosting.Azure.Dapr.Redis Package Description	36.9K
CommunityToolkit.Aspire.Hosting.Dapr.AzureRedis Package Description	3.2K

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on Aspire.Hosting.Azure.Redis:

Repository	Stars
mehdihadeli/food-delivery-microservices 🍔 A practical and cloud-native food delivery microservices, built with .Net Aspire, .Net 9, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.	972
CommunityToolkit/Aspire A community project with additional components and extensions for Aspire	572
foxminchan/BookWorm The practical implementation of Aspire using Microservices, AI-Agents	473

Version	Downloads	Last Updated
13.1.0	19,305	12/17/2025
13.0.2	5,150	12/4/2025
13.0.1	3,428	11/26/2025
13.0.0	21,347	11/11/2025
9.5.2	17,808	10/23/2025
9.5.1	11,187	10/3/2025
9.5.0	7,900	9/25/2025
9.4.2	10,660	9/2/2025
9.4.1	11,061	8/12/2025
9.4.0	8,715	7/29/2025
9.3.1	22,135	6/10/2025
9.3.0	22,609	5/19/2025
9.2.1	5,476	4/24/2025
9.2.0	7,089	4/10/2025
9.1.0	24,661	2/25/2025
9.0.0	22,249	11/12/2024
9.0.0-rc.1.24511.1	1,823	10/15/2024
8.2.2	4,275	10/24/2024
8.2.1	1,752	9/26/2024
8.2.0	4,160	8/29/2024
8.1.0	2,664	7/23/2024
8.0.2	2,617	6/28/2024
8.0.1	2,456	5/21/2024
8.0.0	500	5/21/2024
8.0.0-preview.7.24251.11	509	5/7/2024
8.0.0-preview.6.24214.1	2,854	4/23/2024
8.0.0-preview.5.24201.12	1,236	4/9/2024