RedisBuilderExtensions Methods

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

Methods

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

Class Methods 1 member

Provides extension methods for adding Redis resources to an Hosting.IDistributedApplicationBuilder.

WithDbGate(IResourceBuilder<RedisResource>, Action<IResourceBuilder<DbGateContainerResource>>, string?) extension IResourceBuilder<RedisResource>

Adds an administration and development platform for Redis to the application model using DbGate.

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

RedisBuilderExtensions.cs#L37-L49

Parameters

builder IResourceBuilder<RedisResource> The Redis server resource builder.

configureContainer Action<IResourceBuilder<DbGateContainerResource>> optional Configuration callback for DbGate container resource.

containerName string? optional The name of the container (Optional).

Returns

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

Remarks

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

Examples

Use in application host with a Redis resource

var builder = DistributedApplication.CreateBuilder(args);

var redis = builder.AddRedis("redis")
   .WithDbGate();

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

builder.Build().Run();