RedisBuilderExtensions.AddRedis Method

Definition

Namespace:

Aspire.Hosting

Assembly:

Aspire.Hosting.Redis.dll

Package:

Aspire.Hosting.Redis v8.2.0

Source:

RedisBuilderExtensions.cs

Adds a Redis container to the application model.

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

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

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

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<RedisResource>

A reference to the IResourceBuilder<T>.

Remarks

This resource includes built-in health checks. When this resource is referenced as a dependency using the WaitFor<T>(IResourceBuilder<T>, IResourceBuilder<IResource>) extension method then the dependent resource will wait until the Redis resource is able to service requests.

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