Aspire.Hosting.Redis

Official

📦 Aspire.Hosting.Redisv13.6.0

14Functions

3Types

3 types and 8 members

Types

handleRedisCommanderResource1 members

handleRedisInsightResource3 members

handleRedisResource17 members

Functions

methodaddRedisbuilder

Adds a Redis container to the application model.

addRedis(name: string, port?: number, password?: ParameterResource): RedisResource

methodwithDataBindMountbuilder

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

withDataBindMount(source: string, isReadOnly?: boolean): RedisResource

methodwithDataBindMountbuilder

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

withDataBindMount(source: string): RedisInsightResource

methodwithDataVolumebuilder

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

withDataVolume(name?: string, isReadOnly?: boolean): RedisResource

methodwithDataVolumebuilder

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

withDataVolume(name?: string): RedisInsightResource

methodwithHostPortbuilder

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

withHostPort(port: number): RedisCommanderResource

methodwithHostPortbuilder

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

withHostPort(port: number): RedisInsightResource

methodwithHostPortbuilder

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

withHostPort(port: number): RedisResource

methodwithModulebuilder

Configures the Redis resource to use the specified Redis module by providing its path inside the container.

withModule(path: string): RedisResource

methodwithPasswordbuilder

Configures the password that the Redis resource is used.

withPassword(password: ParameterResource): RedisResource

methodwithPersistencebuilder

Configures a Redis container resource for persistence.

withPersistence(interval?: timespan, keysChangedThreshold?: number): RedisResource

methodwithRedisCommanderbuilder

Adds Redis Commander management UI

withRedisCommander(configureContainer?: (obj: RedisCommanderResource) => Promise<void>, containerName?: string): RedisResource

methodwithRedisInsightbuilder

Adds Redis Insight management UI

withRedisInsight(configureContainer?: (obj: RedisInsightResource) => Promise<void>, containerName?: string): RedisResource

methodwithReplbuilder

Adds a REPL command that opens an authenticated Redis shell in the dashboard terminal dock.

withRepl(): RedisResource