RedisResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Azure.Redis / RedisResource

RedisResource

Docs Reference TypeScript APIs Aspire.Hosting.Azure.Redis RedisResource

Handle TypeScript

📦 Aspire.Hosting.Azure.Redis v13.2.0-preview.1.26159.1

interface RedisResource
  extends IComputeResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  entrypoint: string;
  readonly host: EndpointReferenceExpression;
  readonly name: string;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  tlsEnabled: boolean;
  readonly uriExpression: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): RedisResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): RedisResource;
  withHostPort(port: number): RedisResource;
  withPassword(password: ParameterResource): RedisResource;
  withPersistence(
      interval?: timespan,
      keysChangedThreshold?: number): RedisResource;
  withRedisCommander(configureContainer?: (obj: RedisCommanderResource) => void, containerName?: string): RedisResource;
  withRedisInsight(configureContainer?: (obj: RedisInsightResource) => void, containerName?: string): RedisResource;
}

Implements

• IComputeResource
• IManifestExpressionProvider
• IResource
• IResourceWithArgs
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IValueProvider
• IValueWithReferences

Search members of RedisResource…

method property

19 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property entrypoint string get · set

Gets the Entrypoint property

property host EndpointReferenceExpression get

Gets the Host property

property name string get

Gets the Name property

property port EndpointReferenceExpression get

Gets the Port property

property primaryEndpoint EndpointReference get

Gets the PrimaryEndpoint property

property shellExecution boolean get · set

Gets the ShellExecution property

property tlsEnabled boolean get · set

Gets the TlsEnabled property

property uriExpression ReferenceExpression get

Gets the UriExpression property

Methods

method withDataBindMount builder

Adds a data bind mount with persistence

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

Parameters

source string

isReadOnly boolean optional = False

Returns

RedisResource

method withDataVolume builder

Adds a data volume with persistence

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

Parameters

name string optional

isReadOnly boolean optional = False

Returns

RedisResource

method withHostPort builder

Sets the host port for Redis

withHostPort(port: number): RedisResource

Parameters

port number

Returns

RedisResource

method withPassword builder

Configures the password for Redis

withPassword(password: ParameterResource): RedisResource

Parameters

password ParameterResource

Returns

RedisResource

method withPersistence builder

Configures Redis persistence

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

Parameters

interval timespan optional

keysChangedThreshold number optional = 1

Returns

RedisResource

method withRedisCommander builder

Adds Redis Commander management UI

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

Parameters

configureContainer (obj: RedisCommanderResource) => void optional

containerName string optional

Returns

RedisResource

method withRedisInsight builder

Adds Redis Insight management UI

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

Parameters

configureContainer (obj: RedisInsightResource) => void optional

containerName string optional

Returns

RedisResource