AzureRedisExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Hosting.Azure.Redis / AzureRedisExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting.Azure.Redis AzureRedisExtensions Methods

Class Methods 6 members

Provides extension methods for adding the Azure Redis resources to the application model.

Obsolete — This method is obsolete and will be removed in a future version. Use AddAzureManagedRedis instead which provisions Azure Managed Redis.

AddAzureRedis(IDistributedApplicationBuilder, string) extension IResourceBuilder<AzureRedisCacheResource>

Adds an Azure Cache for Redis resource to the application model.

public static class AzureRedisExtensions
{
    public static IResourceBuilder<AzureRedisCacheResource> AddAzureRedis(
        this IDistributedApplicationBuilder builder,
        string name)
    {
        // ...
    }
}

AzureRedisExtensions.cs#L119-L126

Parameters

builder IDistributedApplicationBuilder The builder for the distributed application.

name string The name of the resource.

Returns

IResourceBuilder<AzureRedisCacheResource> A reference to the ApplicationModel.IResourceBuilder`1 builder.

Remarks

By default, the Azure Cache for Redis resource is configured to use Microsoft Entra ID (Azure Active Directory) for authentication. This requires changes to the application code to use an azure credential to authenticate with the resource. See https://github.com/Azure/Microsoft.Azure.StackExchangeRedis for more information. You can use the AzureRedisExtensions.WithAccessKeyAuthentication method to configure the resource to use access key authentication. The following example creates an Azure Cache for Redis resource and referencing that resource in a .NET project.

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddAzureRedis("cache");

builder.AddProject<Projects.ProductService>()
    .WithReference(cache);

builder.Build().Run();

Obsolete — This method is obsolete and will be removed in a future version. Use AddAzureManagedRedis instead which provisions Azure Managed Redis.

AsAzureRedis(IResourceBuilder<RedisResource>) extension IResourceBuilder<RedisResource>

Configures resource to use Azure for local development and when doing a deployment via the Azure Developer CLI.

public static class AzureRedisExtensions
{
    public static IResourceBuilder<RedisResource> AsAzureRedis(
        this IResourceBuilder<RedisResource> builder)
    {
        // ...
    }
}

AzureRedisExtensions.cs#L86

Parameters

builder IResourceBuilder<RedisResource> The ApplicationModel.IResourceBuilder`1 builder.

Returns

IResourceBuilder<RedisResource> A reference to the ApplicationModel.IResourceBuilder`1 builder.

Obsolete — This method is obsolete and will be removed in a future version. Use AddAzureManagedRedis instead which provisions Azure Managed Redis.

PublishAsAzureRedis(IResourceBuilder<RedisResource>) extension IResourceBuilder<RedisResource>

Configures the resource to be published as Azure Cache for Redis when deployed via Azure Developer CLI.

public static class AzureRedisExtensions
{
    public static IResourceBuilder<RedisResource> PublishAsAzureRedis(
        this IResourceBuilder<RedisResource> builder)
    {
        // ...
    }
}

AzureRedisExtensions.cs#L27

Parameters

builder IResourceBuilder<RedisResource> The ApplicationModel.IResourceBuilder`1 builder.

Returns

IResourceBuilder<RedisResource> A reference to the ApplicationModel.IResourceBuilder`1 builder.

Obsolete — This method is obsolete and will be removed in a future version. Use AddAzureManagedRedis instead which provisions Azure Managed Redis.

RunAsContainer(IResourceBuilder<AzureRedisCacheResource>, Action<IResourceBuilder<RedisResource>>) extension IResourceBuilder<AzureRedisCacheResource>

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

public static class AzureRedisExtensions
{
    public static IResourceBuilder<AzureRedisCacheResource> RunAsContainer(
        this IResourceBuilder<AzureRedisCacheResource> builder,
        Action<IResourceBuilder<RedisResource>>? configureContainer = null)
    {
        // ...
    }
}

AzureRedisExtensions.cs#L157-L173

Parameters

builder IResourceBuilder<AzureRedisCacheResource> The Azure Cache for Redis resource builder.

configureContainer Action<IResourceBuilder<RedisResource>> optional Callback that exposes underlying container to allow for customization.

Returns

IResourceBuilder<AzureRedisCacheResource> A reference to the ApplicationModel.IResourceBuilder`1 builder.

Remarks

The following example creates an Azure Cache for Redis resource that runs locally in a Redis container and referencing that resource in a .NET project.

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddAzureRedis("cache")
    .RunAsContainer();

builder.AddProject<Projects.ProductService>()
    .WithReference(cache);

builder.Build().Run();

Obsolete — This method is obsolete and will be removed in a future version. Use AddAzureManagedRedis instead which provisions Azure Managed Redis.

WithAccessKeyAuthentication(IResourceBuilder<AzureRedisCacheResource>) extension IResourceBuilder<AzureRedisCacheResource>

Configures the resource to use access key authentication for Azure Cache for Redis.

public static class AzureRedisExtensions
{
    public static IResourceBuilder<AzureRedisCacheResource> WithAccessKeyAuthentication(
        this IResourceBuilder<AzureRedisCacheResource> builder)
    {
        // ...
    }
}

AzureRedisExtensions.cs#L200-L219

Parameters

builder IResourceBuilder<AzureRedisCacheResource> The Azure Cache for Redis resource builder.

Returns

IResourceBuilder<AzureRedisCacheResource> A reference to the ApplicationModel.IResourceBuilder`1 builder.

Remarks

The following example creates an Azure Cache for Redis resource that uses access key authentication.

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddAzureRedis("cache")
    .WithAccessKeyAuthentication();

builder.AddProject<Projects.ProductService>()
    .WithReference(cache);

builder.Build().Run();

Obsolete — This method is obsolete and will be removed in a future version. Use AddAzureManagedRedis instead which provisions Azure Managed Redis.

WithAccessKeyAuthentication(IResourceBuilder<AzureRedisCacheResource>, IResourceBuilder<IAzureKeyVaultResource>) extension IResourceBuilder<AzureRedisCacheResource>

Configures the resource to use access key authentication for Azure Cache for Redis.

public static class AzureRedisExtensions
{
    public static IResourceBuilder<AzureRedisCacheResource> WithAccessKeyAuthentication(
        this IResourceBuilder<AzureRedisCacheResource> builder,
        IResourceBuilder<IAzureKeyVaultResource> keyVaultBuilder)
    {
        // ...
    }
}

AzureRedisExtensions.cs#L231-L246

Parameters

builder IResourceBuilder<AzureRedisCacheResource> The Azure Cache for Redis resource builder.

keyVaultBuilder IResourceBuilder<IAzureKeyVaultResource> The Azure Key Vault resource builder where the connection string used to connect to this AzureRedisCacheResource will be stored.

Returns

IResourceBuilder<AzureRedisCacheResource> A reference to the ApplicationModel.IResourceBuilder`1 builder.