Valkey client integration

Valkey is Redis-compatible, so you use the same Redis client packages. To get started, install the 📦 Aspire.StackExchange.Redis NuGet package:

.NET CLI

.NET CLI — Add Aspire.StackExchange.Redis package

dotnet add package Aspire.StackExchange.Redis

Program.cs (C# file-based app)

Program.cs

#:package Aspire.StackExchange.Redis@*

PackageReference (*.csproj)

XML — Add Aspire.StackExchange.Redis package reference

<PackageReference Include="Aspire.StackExchange.Redis" Version="*" />

Add Valkey client

In the Program.cs file of your client-consuming project, call the AddRedisClient extension method to register an IConnectionMultiplexer:

builder.AddRedisClient(connectionName: "cache");

İpucu

The connectionName parameter must match the name used when adding the Valkey resource in the AppHost project.

You can then retrieve the IConnectionMultiplexer instance using dependency injection:

public class ExampleService(IConnectionMultiplexer connectionMux)
{
    // Use connection multiplexer...
}

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}

Example connection string:

Uri: valkey://:p%40ssw0rd1@localhost:6379

Not

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

Configuration and other client features

Since Valkey is Redis-compatible, all Redis client configuration, keyed services, health checks, and observability features work the same way. See the Redis client integration page for complete client integration documentation.

Distributed caching and output caching

Valkey also supports Redis distributed caching and output caching. Install the respective packages:

• For distributed caching: 📦 Aspire.StackExchange.Redis.DistributedCaching
• For output caching: 📦 Aspire.StackExchange.Redis.OutputCaching

See Redis Distributed Caching and Redis Output Caching for usage details.