AzureManagedRedisResource

Handle

📦 Aspire.Hosting.Azure.Redis v13.4.0

interface AzureManagedRedisResource
  extends IAzureResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParameters,
    IValueProvider,
    IValueWithReferences,
    IAzurePrivateEndpointTarget {
  readonly connectionStringExpression: ReferenceExpression;
  readonly hostName: ReferenceExpression;
  readonly id: BicepOutputReference;
  readonly nameOutputReference: BicepOutputReference;
  readonly password: ReferenceExpression;
  readonly port: ReferenceExpression;
  readonly uriExpression: ReferenceExpression;
  readonly useAccessKeyAuthentication: boolean;
  runAsContainer(configureContainer?: (obj: RedisResource) => Promise<void>): AzureManagedRedisResource;
  withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureManagedRedisResource;
}

10 members

Properties

property connectionStringExpression ReferenceExpression get

Gets the connection string template for the manifest for the Azure Managed Redis resource.

property hostName ReferenceExpression get

Gets the host name for the Redis server.

property id BicepOutputReference get

Gets the "id" output reference for the resource.

property nameOutputReference BicepOutputReference get

Gets the "name" output reference for the resource.

property password ReferenceExpression get

Gets the password/access key for the Redis server.

property port ReferenceExpression get

Gets the port for the Redis server.

property uriExpression ReferenceExpression get

Gets the connection URI expression for the Redis server.

property useAccessKeyAuthentication boolean get

Gets a value indicating whether the resource uses access key authentication.

Methods

method runAsContainer builder

Configures an Azure Managed Redis resource to run locally in a container.

runAsContainer(configureContainer?: (obj: RedisResource) => Promise<void>): AzureManagedRedisResource

Parameters

configureContainer (obj: RedisResource) => Promise<void> optional

Returns

AzureManagedRedisResource

method withAccessKeyAuthentication builder

Configures Azure Managed Redis to use access key authentication

withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureManagedRedisResource

Parameters

keyVaultBuilder IAzureKeyVaultResource optional

Returns

AzureManagedRedisResource