Aspire.Hosting.Redis 13.0.0
Aspire.Hosting.Redis library
Provides extension methods and resource definitions for an Aspire AppHost to configure a Redis resource.
Getting started
Install the package
In your AppHost project, install the Aspire Redis Hosting library with NuGet:
dotnet add package Aspire.Hosting.Redis
Usage example
Then, in the AppHost.cs file of AppHost, add a Redis resource and consume the connection using the following methods:
var redis = builder.AddRedis("redis");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(redis);
Connection Properties
When you reference a Redis resource using WithReference, the following connection properties are made available to the consuming project:
Redis
The Redis resource exposes the following connection properties:
| Property Name | Description |
|---|---|
Host |
The hostname or IP address of the Redis server |
Port |
The port number the Redis server is listening on |
Password |
The password for authentication |
Uri |
The connection URI, with the format redis://:{Password}@{Host}:{Port} |
Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called db1 becomes DB1_URI.
Additional documentation
- https://learn.microsoft.com/dotnet/aspire/caching/stackexchange-redis-component
- https://learn.microsoft.com/dotnet/aspire/caching/stackexchange-redis-output-caching-component
- https://learn.microsoft.com/dotnet/aspire/caching/stackexchange-redis-distributed-caching-component
Feedback & contributing
https://github.com/dotnet/aspire
*Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd.
No packages depend on Aspire.Hosting.Redis.
.NET 8.0
- Aspire.Hosting (>= 13.0.0)
- System.IO.Hashing (>= 9.0.10)
- StreamJsonRpc (>= 2.22.23)
- StackExchange.Redis (>= 2.9.32)
- Semver (>= 3.0.0)
- Polly.Core (>= 8.6.4)
- Newtonsoft.Json (>= 13.0.4)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- KubernetesClient (>= 18.0.5)
- JsonPatch.Net (>= 3.3.0)
- Humanizer.Core (>= 2.14.1)
- Grpc.Tools (>= 2.72.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.AspNetCore (>= 2.71.0)
- Google.Protobuf (>= 3.33.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- AspNetCore.HealthChecks.Redis (>= 9.0.0)
| Version | Downloads | Last updated |
|---|---|---|
| 13.0.0 | 2 | 11/20/2025 |
| 9.5.2 | 5 | 10/26/2025 |
| 9.5.1 | 7 | 10/09/2025 |
| 9.5.0 | 8 | 09/26/2025 |
| 9.4.2 | 10 | 09/12/2025 |
| 9.4.1 | 9 | 08/15/2025 |
| 9.4.0 | 8 | 08/06/2025 |
| 9.3.1 | 13 | 06/15/2025 |
| 9.3.0 | 14 | 05/23/2025 |
| 9.2.1 | 14 | 04/27/2025 |
| 9.2.0 | 14 | 04/15/2025 |
| 9.1.0 | 19 | 03/07/2025 |
| 9.0.0 | 19 | 03/07/2025 |
| 9.0.0-rc.1.24511.1 | 15 | 03/07/2025 |
| 8.2.2 | 18 | 03/07/2025 |
| 8.2.1 | 18 | 03/07/2025 |
| 8.2.0 | 19 | 03/07/2025 |
| 8.1.0 | 18 | 03/07/2025 |
| 8.0.2 | 17 | 03/07/2025 |
| 8.0.1 | 18 | 03/07/2025 |
| 8.0.0 | 18 | 03/07/2025 |
| 8.0.0-preview.7.24251.11 | 18 | 03/07/2025 |
| 8.0.0-preview.6.24214.1 | 18 | 03/07/2025 |
| 8.0.0-preview.5.24201.12 | 19 | 03/07/2025 |