aspnet

page_type	languages	name	description	products
sample	aspx-csharp csharp	Quickstart: Use Azure Cache for Redis with an ASP.NET web app	Learn how to use an ASP.NET web application to connect to Azure Cache for Redis to store and retrieve data from the cache.	azure aspnet azure-cache-redis

Quickstart: Use Azure Cache for Redis with an ASP.NET web app

This sample shows you how to use an ASP.NET web application to connect to Azure Cache for Redis to store and retrieve data from the cache. See the accompanying article on the documentation site for details, including best practices and how to create the sample code from scratch.

Prerequisites

• Azure subscription - create one for free
• Azure Cache for Redis cache - create one
• Visual Studio with the ASP.NET and web development and Azure development workloads.
• Azure CLI

Set up the working environment

1. Set up local credential for using Entra ID

This sample uses Microsoft Entra ID for connecting to an Azure Cache for Redis instance.

One of the common way for signing into to your Azure account is to use the Azure CLI. Bring up the Command Prompt. Run

<appSettings>
    <add key="CacheConnection" value="<cache-name>.redis.cache.windows.net,abortConnect=false,ssl=true,allowAdmin=true,password=<access-key>"/>
</appSettings>

Replace <cache-name> with your cache host name.

Replace <access-key> with the primary key for your cache.

2. Point to an Azure Cache for Redis instance from local configuration

Edit the Web.config file and add the following contents:

<appSettings>
    <!--setting to add for pointing to an Azure Cache for Redis instance-->
    <add key="RedisCacheName" value="<cache-name>.redis.cache.windows.net"/>
</appSettings>

3. Add the permissions to allow the Entra ID to connect to the Azure Cache for Redis instance

Follow instruction at Use Microsoft Entra ID for cache authentication

Run the sample locally

Download the sample code to your development PC.

In Visual Studio, click File > Open > Project/Solution.

Navigate to the folder containing this sample, and select the solution file contained within it.

Open Tools > NuGet Package Manager > Package Manager Console and install the bootstrap NuGet package:

Install-Package bootstrap -Version 3.4.1

Open your web.config file and update the appSettings RedisCacheHome attribute to the correct path.

In Visual Studio, select Debug > Start Debugging to build and start the app locally for testing and debugging.

In the browser, select Azure Cache for Redis Test on the navigation bar.

Publish and run in Azure

See the accompanying article on the documentation site for details about how to publish and run the app in Azure.

References

• Quickstart article on the documentation site