RedisBuilderExtensions Methods
ClassMethods2 members
Provides extension methods for adding Redis resources to an
Hosting.IDistributedApplicationBuilder. WithDbGate(IResourceBuilder<RedisResource>, Action<IResourceBuilder<DbGateContainerResource>>, string?)Section titled WithDbGate(IResourceBuilder<RedisResource>, Action<IResourceBuilder<DbGateContainerResource>>, string?)extensionIResourceBuilder<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) { // ... }}Parameters
builderIResourceBuilder<RedisResource>The Redis server resource builder.configureContainerAction<IResourceBuilder<DbGateContainerResource>>optionalConfiguration callback for DbGate container resource.containerNamestring?optionalThe 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();WithDbx(IResourceBuilder<RedisResource>, Action<IResourceBuilder<DbxContainerResource>>, string?)Section titled WithDbx(IResourceBuilder<RedisResource>, Action<IResourceBuilder<DbxContainerResource>>, string?)extensionIResourceBuilder<RedisResource> Adds an administration and development platform for Redis to the application model using dbx.
public static class RedisBuilderExtensions{ public static IResourceBuilder<RedisResource> WithDbx( this IResourceBuilder<RedisResource> builder, Action<IResourceBuilder<DbxContainerResource>>? configureContainer = null, string? containerName = null) { // ... }}Parameters
builderIResourceBuilder<RedisResource>The Redis server resource builder.configureContainerAction<IResourceBuilder<DbxContainerResource>>optionalConfiguration callback for dbx container resource.containerNamestring?optionalThe 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. This overload is not available in polyglot AppHosts. Use
RedisBuilderExtensions.WithDbx instead. Examples
Use in application host with a Postgres resource
var builder = DistributedApplication.CreateBuilder(args);
var redis = builder.AddRedis("redis") .WithDbx();
var api = builder.AddProject<Projects.Api>("api") .WithReference(redis);
builder.Build().Run();
Aspire