AspireRedisOutputCacheExtensions.AddRedisOutputCache Method

Reference

Definition

Namespace:: Microsoft.Extensions.Hosting

Assembly:: Aspire.StackExchange.Redis.OutputCaching.dll

Package:: Aspire.StackExchange.Redis.OutputCaching v8.0.0-preview.7.24251.11

Source:: AspireRedisOutputCacheExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds Redis output caching services in the services provided by the builder.

public static void AddRedisOutputCache (this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string connectionName, Action<Aspire.StackExchange.Redis.StackExchangeRedisSettings>? configureSettings = default, Action<StackExchange.Redis.ConfigurationOptions>? configureOptions = default);

static member AddRedisOutputCache : Microsoft.Extensions.Hosting.IHostApplicationBuilder * string * Action<Aspire.StackExchange.Redis.StackExchangeRedisSettings> * Action<StackExchange.Redis.ConfigurationOptions> -> unit

<Extension()>
Public Sub AddRedisOutputCache (builder As IHostApplicationBuilder, connectionName As String, Optional configureSettings As Action(Of StackExchangeRedisSettings) = Nothing, Optional configureOptions As Action(Of ConfigurationOptions) = Nothing)

Parameters

builder: IHostApplicationBuilder

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

An optional method that can be used for customizing the StackExchangeRedisSettings. It's invoked after the settings are read from the configuration.

configureOptions: Action<StackExchange.Redis.ConfigurationOptions>

An optional method that can be used for customizing the StackExchange.Redis.ConfigurationOptions. It's invoked after the options are read from the configuration.

Remarks

Reads the configuration from "Aspire:StackExchange:Redis" section.

Also registers StackExchange.Redis.IConnectionMultiplexer as a singleton in the services provided by the builder. Enables retries, corresponding health check, logging, and telemetry.

Applies to