Aspire.Hosting.Azure.Redis 8.2.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Aspire.Hosting.Azure.Redis --version 8.2.2                

                    
                

            
NuGet\Install-Package Aspire.Hosting.Azure.Redis -Version 8.2.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Aspire.Hosting.Azure.Redis" Version="8.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Aspire.Hosting.Azure.Redis --version 8.2.2                

                    
                

            
#r "nuget: Aspire.Hosting.Azure.Redis, 8.2.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Aspire.Hosting.Azure.Redis as a Cake Addin
#addin nuget:?package=Aspire.Hosting.Azure.Redis&version=8.2.2

// Install Aspire.Hosting.Azure.Redis as a Cake Tool
#tool nuget:?package=Aspire.Hosting.Azure.Redis&version=8.2.2

Aspire.Hosting.Azure.Redis library

Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure Cache for Redis.

Getting started

Prerequisites

Install the package

In your AppHost project, install the Aspire.Hosting.Azure.Redis library with NuGet:

dotnet add package Aspire.Hosting.Azure.Redis

Configure Azure Provisioning for local development

Adding Azure resources to the .NET Aspire application model will automatically enable development-time provisioning for Azure resources so that you don't need to configure them manually. Provisioning requires a number of settings to be available via .NET configuration. Set these values in user secrets in order to allow resources to be configured automatically.

{
    "Azure": {
      "SubscriptionId": "<your subscription id>",
      "ResourceGroupPrefix": "<prefix for the resource group>",
      "Location": "<azure location>"
    }
}

NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.

Usage example

Then, in the Program.cs file of AppHost, register a Redis server and consume the connection using the following methods:

var redis = builder.AddRedis("cache")
                   .AsAzureRedis();

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(redis);

The WithReference method configures a connection in the MyService project named cache. In the Program.cs file of MyService, the redis connection can be consumed using the client library Aspire.StackExchange.Redis:

builder.AddRedisClient("cache");

Additional documentation

Feedback & contributing

https://github.com/dotnet/aspire

*Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Aspire.Hosting.Azure.Redis:

Package Downloads
CommunityToolkit.Aspire.Hosting.Dapr.AzureRedis

Package Description

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Aspire.Hosting.Azure.Redis:

Repository Stars
CommunityToolkit/Aspire
A community project with additional components and extensions for .NET Aspire
Version Downloads Last updated
9.0.0 10,093 11/12/2024
9.0.0-rc.1.24511.1 1,548 10/15/2024
8.2.2 2,520 10/24/2024
8.2.1 1,368 9/26/2024
8.2.0 3,638 8/29/2024
8.1.0 2,416 7/23/2024
8.0.2 1,622 6/28/2024
8.0.1 2,236 5/21/2024
8.0.0 190 5/21/2024
8.0.0-preview.7.24251.11 343 5/7/2024
8.0.0-preview.6.24214.1 2,661 4/23/2024
8.0.0-preview.5.24201.12 1,051 4/9/2024