ValkeyBuilderExtensions.AddValkey Method

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.Valkey.dll

Package:: Aspire.Hosting.Valkey v8.2.0

Package:: Aspire.Hosting.Valkey v9.0.0

Package:: Aspire.Hosting.Valkey v9.1.0

Package:: Aspire.Hosting.Valkey v9.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

AddValkey(IDistributedApplicationBuilder, String, Nullable<Int32>)	Adds a Valkey container to the application model.
AddValkey(IDistributedApplicationBuilder, String, Nullable<Int32>, IResourceBuilder<ParameterResource>)	Adds a Valkey container to the application model.

AddValkey(IDistributedApplicationBuilder, String, Nullable<Int32>)

Source:: ValkeyBuilderExtensions.cs

Source:: ValkeyBuilderExtensions.cs

Source:: ValkeyBuilderExtensions.cs

Source:: ValkeyBuilderExtensions.cs

Adds a Valkey container to the application model.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ValkeyResource> AddValkey(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, int? port = default);

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ValkeyResource> AddValkey(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, int? port);

static member AddValkey : Aspire.Hosting.IDistributedApplicationBuilder * string * Nullable<int> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ValkeyResource>

<Extension()>
Public Function AddValkey (builder As IDistributedApplicationBuilder, name As String, Optional port As Nullable(Of Integer) = Nothing) As IResourceBuilder(Of ValkeyResource)

<Extension()>
Public Function AddValkey (builder As IDistributedApplicationBuilder, name As String, port As Nullable(Of Integer)) As IResourceBuilder(Of ValkeyResource)

Parameters

builder: IDistributedApplicationBuilder

The IDistributedApplicationBuilder.

name: String

The name of the resource. This name will be used as the connection string name when referenced in a dependency.

port: Nullable<Int32>

The host port to bind the underlying container to.

Returns

IResourceBuilder<ValkeyResource>

A reference to the IResourceBuilder<T>.

Examples

Use in application host

var builder = DistributedApplication.CreateBuilder(args);

var valkey = builder.AddValkey("valkey");
var api = builder.AddProject<Projects.Api>("api)
                 .WithReference(valkey);

builder.Build().Run();

Use in service project with Aspire.StackExchange.Redis package.

var builder = WebApplication.CreateBuilder(args);
builder.AddRedisClient("valkey");

var multiplexer = builder.Services.BuildServiceProvider()
                                  .GetRequiredService<IConnectionMultiplexer>();

var db = multiplexer.GetDatabase();
db.HashSet("key", [new HashEntry("hash", "value")]);
var value = db.HashGet("key", "hash");

Remarks

This version of the package defaults to the tag of the container image.

Applies to

AddValkey(IDistributedApplicationBuilder, String, Nullable<Int32>, IResourceBuilder<ParameterResource>)

Source:: ValkeyBuilderExtensions.cs

Adds a Valkey container to the application model.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ValkeyResource> AddValkey(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, int? port = default, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource>? password = default);

static member AddValkey : Aspire.Hosting.IDistributedApplicationBuilder * string * Nullable<int> * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ValkeyResource>

<Extension()>
Public Function AddValkey (builder As IDistributedApplicationBuilder, name As String, Optional port As Nullable(Of Integer) = Nothing, Optional password As IResourceBuilder(Of ParameterResource) = Nothing) As IResourceBuilder(Of ValkeyResource)