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

propertyconnectionStringExpressionReferenceExpressionget

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

propertyhostNameReferenceExpressionget

Gets the host name for the Redis server.

propertyidBicepOutputReferenceget

Gets the "id" output reference for the resource.

propertynameOutputReferenceBicepOutputReferenceget

Gets the "name" output reference for the resource.

propertypasswordReferenceExpressionget

Gets the password/access key for the Redis server.

propertyportReferenceExpressionget

Gets the port for the Redis server.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the Redis server.

propertyuseAccessKeyAuthenticationbooleanget

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

Methods

methodrunAsContainerbuilder

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

methodwithAccessKeyAuthenticationbuilder

Configures Azure Managed Redis to use access key authentication

withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureManagedRedisResource

Parameters

keyVaultBuilderIAzureKeyVaultResourceoptional

Returns

AzureManagedRedisResource