RedisBuilderExtensions Methods

Docs/Reference/Search C# APIs/Aspire.Hosting.Redis/RedisBuilderExtensions/Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting.Redis RedisBuilderExtensions Methods

ClassMethods13 members

Provides extension methods for adding Redis resources to the application model.

AddRedis(IDistributedApplicationBuilder, string, int?)extensionIResourceBuilder<RedisResource>

Adds a Redis container to the application model.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> AddRedis(
        this IDistributedApplicationBuilder builder,
        string name,
        int? port)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L41

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

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

portint?The host port to bind the underlying container to.

Returns

IResourceBuilder<RedisResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This resource includes built-in health checks. When this resource is referenced as a dependency using the ResourceBuilderExtensions.WaitFor 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.

Ignored by ATS

Excluded from automatic Polyglot export.

AddRedis(IDistributedApplicationBuilder, string, int?, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<RedisResource>

Adds a Redis container to the application model.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> AddRedis(
        this IDistributedApplicationBuilder builder,
        string name,
        int? port = null,
        IResourceBuilder<ParameterResource>? password = null)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L70-L201

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

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

portint?optionalThe host port to bind the underlying container to.

passwordIResourceBuilder<ParameterResource>optionalThe parameter used to provide the password for the Redis resource. If null a random password will be generated.

Returns

IResourceBuilder<RedisResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

This resource includes built-in health checks. When this resource is referenced as a dependency using the ResourceBuilderExtensions.WaitFor 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.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithDataBindMount(IResourceBuilder<RedisResource>, string, bool)extensionIResourceBuilder<RedisResource>

Adds a bind mount for the data folder to a Redis container resource and enables Redis persistence.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> WithDataBindMount(
        this IResourceBuilder<RedisResource> builder,
        string source,
        bool isReadOnly = false)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L479-L487

Parameters

builderIResourceBuilder<RedisResource>The resource builder.

sourcestringThe source directory on the host to mount into the container.

isReadOnlybooloptional A flag that indicates if this is a read-only mount. Setting this to true will disable Redis persistence. Defaults to false.

Returns

IResourceBuilder<RedisResource>The ApplicationModel.IResourceBuilder`1.

Remarks

Use RedisBuilderExtensions.WithPersistence to adjust Redis persistence configuration, e.g.:

var cache = builder.AddRedis("cache")
                   .WithDataBindMount("myredisdata")
                   .WithPersistence(TimeSpan.FromSeconds(10), 5);

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithDataBindMount(IResourceBuilder<RedisInsightResource>, string)extensionIResourceBuilder<RedisInsightResource>

Adds a bind mount for the data folder to a Redis Insight container resource.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisInsightResource> WithDataBindMount(
        this IResourceBuilder<RedisInsightResource> builder,
        string source)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L549-L552

Parameters

builderIResourceBuilder<RedisInsightResource>The resource builder.

sourcestringThe source directory on the host to mount into the container.

Returns

IResourceBuilder<RedisInsightResource>The ApplicationModel.IResourceBuilder`1.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithDataVolume(IResourceBuilder<RedisResource>, string?, bool)extensionIResourceBuilder<RedisResource>

Adds a named volume for the data folder to a Redis container resource and enables Redis persistence.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> WithDataVolume(
        this IResourceBuilder<RedisResource> builder,
        string? name = null,
        bool isReadOnly = false)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L446-L453

Parameters

builderIResourceBuilder<RedisResource>The resource builder.

namestring?optionalThe name of the volume. Defaults to an auto-generated name based on the application and resource names.

isReadOnlybooloptional A flag that indicates if this is a read-only volume. Setting this to true will disable Redis persistence. Defaults to false.

Returns

IResourceBuilder<RedisResource>The ApplicationModel.IResourceBuilder`1.

Remarks

Use RedisBuilderExtensions.WithPersistence to adjust Redis persistence configuration, e.g.:

var cache = builder.AddRedis("cache")
                   .WithDataVolume()
                   .WithPersistence(TimeSpan.FromSeconds(10), 5);

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithDataVolume(IResourceBuilder<RedisInsightResource>, string?)extensionIResourceBuilder<RedisInsightResource>

Adds a named volume for the data folder to a Redis Insight container resource.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisInsightResource> WithDataVolume(
        this IResourceBuilder<RedisInsightResource> builder,
        string? name = null)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L534-L536

Parameters

builderIResourceBuilder<RedisInsightResource>The resource builder.

namestring?optionalThe name of the volume. Defaults to an auto-generated name based on the application and resource names.

Returns

IResourceBuilder<RedisInsightResource>The ApplicationModel.IResourceBuilder`1.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithHostPort(IResourceBuilder<RedisCommanderResource>, int?)extensionIResourceBuilder<RedisCommanderResource>

Configures the host port that the Redis Commander resource is exposed on instead of using randomly assigned port.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisCommanderResource> WithHostPort(
        this IResourceBuilder<RedisCommanderResource> builder,
        int? port)
    {
        // ...
    }
}

RedisBuilderExtensions.cs

Parameters

builderIResourceBuilder<RedisCommanderResource>The resource builder for Redis Commander.

portint?The port to bind on the host. If null is used random port will be assigned.

Returns

IResourceBuilder<RedisCommanderResource>The resource builder for RedisCommander.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithHostPort(IResourceBuilder<RedisInsightResource>, int?)extensionIResourceBuilder<RedisInsightResource>

Configures the host port that the Redis Insight resource is exposed on instead of using randomly assigned port.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisInsightResource> WithHostPort(
        this IResourceBuilder<RedisInsightResource> builder,
        int? port)
    {
        // ...
    }
}

RedisBuilderExtensions.cs

Parameters

builderIResourceBuilder<RedisInsightResource>The resource builder for Redis Insight.

portint?The port to bind on the host. If null is used random port will be assigned.

Returns

IResourceBuilder<RedisInsightResource>The resource builder for RedisInsight.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithHostPort(IResourceBuilder<RedisResource>, int?)extensionIResourceBuilder<RedisResource>

Configures the host port that the Redis resource is exposed on instead of using randomly assigned port.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> WithHostPort(
        this IResourceBuilder<RedisResource> builder,
        int? port)
    {
        // ...
    }
}

RedisBuilderExtensions.cs

Parameters

builderIResourceBuilder<RedisResource>The resource builder.

portint?The port to bind on the host. If null is used random port will be assigned.

Returns

IResourceBuilder<RedisResource>The ApplicationModel.IResourceBuilder`1.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithPassword(IResourceBuilder<RedisResource>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<RedisResource>

Configures the password that the Redis resource is used.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> WithPassword(
        this IResourceBuilder<RedisResource> builder,
        IResourceBuilder<ParameterResource>? password)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L565-L568

Parameters

builderIResourceBuilder<RedisResource>The resource builder.

passwordIResourceBuilder<ParameterResource>The parameter used to provide the password for the Redis resource. If null, no password will be configured.

Returns

IResourceBuilder<RedisResource>The ApplicationModel.IResourceBuilder`1.

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithPersistence(IResourceBuilder<RedisResource>, TimeSpan?, long)extensionIResourceBuilder<RedisResource>

Configures a Redis container resource for persistence.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> WithPersistence(
        this IResourceBuilder<RedisResource> builder,
        TimeSpan? interval = null,
        long keysChangedThreshold = 1)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L511-L514

Parameters

builderIResourceBuilder<RedisResource>The resource builder.

intervalTimeSpan?optionalThe interval between snapshot exports. Defaults to 60 seconds.

keysChangedThresholdlongoptionalThe number of key change operations required to trigger a snapshot at the interval. Defaults to 1.

Returns

IResourceBuilder<RedisResource>The ApplicationModel.IResourceBuilder`1.

Remarks

Use with RedisBuilderExtensions.WithDataBindMount or RedisBuilderExtensions.WithDataVolume to persist Redis data across sessions with custom persistence configuration, e.g.:

var cache = builder.AddRedis("cache")
                   .WithDataVolume()
                   .WithPersistence(TimeSpan.FromSeconds(10), 5);

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithRedisCommander(IResourceBuilder<RedisResource>, Action<IResourceBuilder<RedisCommanderResource>>, string?)extensionIResourceBuilder<RedisResource>

Configures a container resource for Redis Commander which is pre-configured to connect to the RedisResource that this method is used on.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> WithRedisCommander(
        this IResourceBuilder<RedisResource> builder,
        Action<IResourceBuilder<RedisCommanderResource>>? configureContainer = null,
        string? containerName = null)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L218-L279

Parameters

builderIResourceBuilder<RedisResource>The ApplicationModel.IResourceBuilder`1 for the RedisResource.

configureContainerAction<IResourceBuilder<RedisCommanderResource>>optionalConfiguration callback for Redis Commander container resource.

containerNamestring?optionalOverride the container name used for Redis Commander.

Remarks

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

ATS export

Available to Polyglot AppHosts through the Aspire Type System.

WithRedisInsight(IResourceBuilder<RedisResource>, Action<IResourceBuilder<RedisInsightResource>>, string?)extensionIResourceBuilder<RedisResource>

Configures a container resource for Redis Insight which is pre-configured to connect to the RedisResource that this method is used on.

public static class RedisBuilderExtensions
{
    public static IResourceBuilder<RedisResource> WithRedisInsight(
        this IResourceBuilder<RedisResource> builder,
        Action<IResourceBuilder<RedisInsightResource>>? configureContainer = null,
        string? containerName = null)
    {
        // ...
    }
}

RedisBuilderExtensions.cs#L297-L385

Parameters

builderIResourceBuilder<RedisResource>The ApplicationModel.IResourceBuilder`1 for the RedisResource.

configureContainerAction<IResourceBuilder<RedisInsightResource>>optionalConfiguration callback for Redis Insight container resource.

containerNamestring?optionalOverride the container name used for Redis Insight.

Remarks

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

ATS export

Available to Polyglot AppHosts through the Aspire Type System.