Skip to content
Docs Try Aspire

AspireRedisOutputCacheExtensions Methods

Class Methods 3 members
Provides extension methods for adding Redis output caching services to the Hosting.IHostApplicationBuilder.
AddKeyedRedisOutputCache(IHostApplicationBuilder, string, Action<StackExchangeRedisSettings>, Action<ConfigurationOptions>) Section titled AddKeyedRedisOutputCache(IHostApplicationBuilder, string, Action<StackExchangeRedisSettings>, Action<ConfigurationOptions>) extension
Adds Redis output caching services for the given name in the services provided by the builder.
public static class AspireRedisOutputCacheExtensions
{
public static void AddKeyedRedisOutputCache(
this IHostApplicationBuilder builder,
string name,
Action<StackExchangeRedisSettings>? configureSettings = null,
Action<ConfigurationOptions>? configureOptions = null)
{
// ...
}
}
builder IHostApplicationBuilder The Hosting.IHostApplicationBuilder to read config from and add services to.
name string The name of the component, which is used as the ServiceDescriptor.ServiceKey of the service and also to retrieve the connection string from the ConnectionStrings configuration section.
configureSettings Action<StackExchangeRedisSettings> optional An optional method that can be used for customizing the Redis.StackExchangeRedisSettings. It's invoked after the settings are read from the configuration.
configureOptions Action<ConfigurationOptions> optional An optional method that can be used for customizing the Redis.ConfigurationOptions. It's invoked after the options are read from the configuration.
Reads the configuration from "Aspire:StackExchange:Redis:{name}" section. Also registers Redis.IConnectionMultiplexer as a singleton in the services provided by the builder. Enables retries, corresponding health check, logging, and telemetry.
AddRedisOutputCache(IHostApplicationBuilder, string, Action<StackExchangeRedisSettings>, Action<ConfigurationOptions>) Section titled AddRedisOutputCache(IHostApplicationBuilder, string, Action<StackExchangeRedisSettings>, Action<ConfigurationOptions>) extension
Adds Redis output caching services in the services provided by the builder.
public static class AspireRedisOutputCacheExtensions
{
public static void AddRedisOutputCache(
this IHostApplicationBuilder builder,
string connectionName,
Action<StackExchangeRedisSettings>? configureSettings = null,
Action<ConfigurationOptions>? configureOptions = null)
{
// ...
}
}
builder IHostApplicationBuilder The Hosting.IHostApplicationBuilder to read config from and add services to.
connectionName string A name used to retrieve the connection string from the ConnectionStrings configuration section.
configureSettings Action<StackExchangeRedisSettings> optional An optional method that can be used for customizing the Redis.StackExchangeRedisSettings. It's invoked after the settings are read from the configuration.
configureOptions Action<ConfigurationOptions> optional An optional method that can be used for customizing the Redis.ConfigurationOptions. It's invoked after the options are read from the configuration.
Reads the configuration from "Aspire:StackExchange:Redis" section. Also registers Redis.IConnectionMultiplexer as a singleton in the services provided by the builder. Enables retries, corresponding health check, logging, and telemetry.
WithOutputCache(AspireRedisClientBuilder) Section titled WithOutputCache(AspireRedisClientBuilder) extension AspireRedisClientBuilder
Configures the Redis client to provide output caching services through OutputCaching.IOutputCacheStore.
public static class AspireRedisOutputCacheExtensions
{
public static AspireRedisClientBuilder WithOutputCache(
this AspireRedisClientBuilder builder)
{
// ...
}
}
builder AspireRedisClientBuilder The Redis.AspireRedisClientBuilder to configure.
AspireRedisClientBuilder The Redis.AspireRedisClientBuilder for method chaining.