Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

AzureManagedRedisResource

Handle
📦 Aspire.Hosting.Azure.Redis v17.0.0

Represents an Azure Managed Redis resource.

type AzureManagedRedisResource interface {
ExpressionValue
Resource
ResourceWithConnectionString
}

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string template for the manifest for the Azure Managed Redis resource.
ConnectionStringExpression() *ReferenceExpression
propertyHostName*ReferenceExpressionget
Gets the host name for the Redis server.
HostName() *ReferenceExpression
propertyIdBicepOutputReferenceget
Gets the "id" output reference for the resource.
Id() BicepOutputReference
propertyNameOutputReferenceBicepOutputReferenceget
Gets the "name" output reference for the resource.
NameOutputReference() BicepOutputReference
propertyPassword*ReferenceExpressionget
Gets the password/access key for the Redis server.
Password() *ReferenceExpression
propertyPort*ReferenceExpressionget
Gets the port for the Redis server.
Port() *ReferenceExpression
propertyResourceTypeDisplayNamestringget
Gets the ResourceTypeDisplayName property
ResourceTypeDisplayName() (string, error)
propertyUriExpression*ReferenceExpressionget
Gets the connection URI expression for the Redis server.
UriExpression() *ReferenceExpression
propertyUseAccessKeyAuthenticationboolget
Gets a value indicating whether the resource uses access key authentication.
UseAccessKeyAuthentication() (bool, error)

Methods

methodRunAsContainerbuilder
Configures an Azure Managed Redis resource to run locally in a container.
RunAsContainer(options ...*RunAsContainerOptions) AzureManagedRedisResource
options...*RunAsContainerOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*RunAsContainerOptions argument.

ConfigureContainerfunc(obj RedisResource)callbackCallback that exposes underlying container to allow for customization.
AzureManagedRedisResource

The resource builder.

Returns a handle; failures surface later via Err().

Configures Azure Managed Redis to use access key authentication
WithAccessKeyAuthentication(options ...*WithAccessKeyAuthenticationOptions) AzureManagedRedisResource
options...*WithAccessKeyAuthenticationOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithAccessKeyAuthenticationOptions argument.

KeyVaultBuilder*AzureKeyVaultResource
AzureManagedRedisResource

Returns a handle; failures surface later via Err().