Aspire.Hosting.Valkey
13.4.6
Prefix Reserved
dotnet add package Aspire.Hosting.Valkey --version 13.4.6
NuGet\Install-Package Aspire.Hosting.Valkey -Version 13.4.6
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.Valkey" Version="13.4.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Aspire.Hosting.Valkey" Version="13.4.6" />
<PackageReference Include="Aspire.Hosting.Valkey" />
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.Valkey --version 13.4.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Aspire.Hosting.Valkey, 13.4.6"
#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.Valkey@13.4.6
#: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.Valkey&version=13.4.6
#tool nuget:?package=Aspire.Hosting.Valkey&version=13.4.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Aspire.Hosting.Valkey library
Provides extension methods and resource definitions for an Aspire AppHost to configure a Valkey cache resource.
Getting started
Install the package
In your AppHost project, install the Aspire Valkey Hosting library with NuGet:
dotnet add package Aspire.Hosting.Valkey
Usage example
Then, in the AppHost.cs file of AppHost, add a Valkey resource and consume the connection using the following methods:
var valkey = builder.AddValkey("cache");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(valkey);
Connection Properties
When you reference a Valkey resource using WithReference, the following connection properties are made available to the consuming project:
Valkey
The Valkey resource exposes the following connection properties:
| Property Name | Description |
|---|---|
Host |
The hostname or IP address of the Valkey server |
Port |
The port number the Valkey server is listening on |
Password |
The password for authentication |
Uri |
The connection URI, with the format valkey://:{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://valkey.io
- https://github.com/valkey-io/valkey/blob/unstable/README.md
- https://stackexchange.github.io/StackExchange.Redis/Basics
- https://github.com/microsoft/aspire/tree/main/src/Components/README.md
Feedback & contributing
| Product | Versions 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.
-
net8.0
- Aspire.Hosting (>= 13.4.6)
- AspNetCore.HealthChecks.Redis (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Google.Protobuf (>= 3.34.1)
- Grpc.AspNetCore (>= 2.80.0)
- Grpc.Net.ClientFactory (>= 2.80.0)
- Grpc.Tools (>= 2.80.0)
- Humanizer.Core (>= 3.0.10)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 19.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.8)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.27)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.8)
- Microsoft.Extensions.Hosting (>= 10.0.8)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Http (>= 10.0.8)
- Microsoft.Extensions.Logging (>= 10.0.8)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Options (>= 10.0.8)
- Microsoft.Extensions.Primitives (>= 10.0.8)
- ModelContextProtocol (>= 1.3.0)
- Newtonsoft.Json (>= 13.0.4)
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.15.3)
- OpenTelemetry.Extensions.Hosting (>= 1.15.3)
- Polly.Core (>= 8.6.6)
- Semver (>= 3.0.0)
- StackExchange.Redis (>= 2.13.1)
- StreamJsonRpc (>= 2.25.29)
- System.IO.Hashing (>= 10.0.8)
- System.Text.Json (>= 10.0.8)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Aspire.Hosting.Valkey:
| Package | Downloads |
|---|---|
|
Aspire.Hosting.AWS
Add support for provisioning AWS application resources and configuring the AWS SDK for .NET. |
|
|
Bielu.Aspire.Infisical
Package Description |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on Aspire.Hosting.Valkey:
| Repository | Stars |
|---|---|
|
aws/integrations-on-dotnet-aspire-for-aws
This repositry contains the integrations with .NET Aspire for AWS.
|
|
|
PacktPublishing/Pragmatic-Microservices-with-CSharp-and-Azure
Pragmatic Microservices with C# and Azure, published by Packt
|
| Version | Downloads | Last Updated |
|---|---|---|
| 13.4.6 | 15,839 | 6/19/2026 |
| 13.4.5 | 4,956 | 6/17/2026 |
| 13.4.4 | 4,241 | 6/15/2026 |
| 13.4.3 | 19,877 | 6/8/2026 |
| 13.4.2 | 2,864 | 6/3/2026 |
| 13.4.1 | 222 | 6/3/2026 |
| 13.4.0 | 2,871 | 6/1/2026 |
| 13.3.5 | 53,697 | 5/21/2026 |
| 13.3.4 | 4,574 | 5/19/2026 |
| 13.3.3 | 5,641 | 5/15/2026 |
| 13.3.2 | 2,189 | 5/14/2026 |
| 13.3.1 | 2,662 | 5/12/2026 |
| 13.3.0 | 33,471 | 5/7/2026 |
| 13.2.4 | 12,997 | 4/24/2026 |
| 13.2.3 | 4,846 | 4/21/2026 |
| 13.2.2 | 8,174 | 4/8/2026 |
| 13.2.1 | 4,722 | 3/31/2026 |
| 13.2.0 | 12,207 | 3/23/2026 |
| 13.1.3 | 1,476 | 3/19/2026 |
| 13.1.2 | 24,949 | 2/26/2026 |
Loading failed