Skip to content

Latest commit

 

History

History
192 lines (112 loc) · 8.89 KB

web-app-cache-howto.md

File metadata and controls

192 lines (112 loc) · 8.89 KB
titledescriptionms.topicms.datems.customzone_pivot_groupsappliesto
Create an ASP.NET web app with an Azure Redis cache
In this quickstart, you learn how to create an ASP.NET web app with an Azure Redis cache
quickstart
12/12/2024
devx-track-csharp, mvc, mode-other, ignite-2024
redis-type
✅ Azure Cache for Redis

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

In this quickstart, you use Visual Studio 2019 to create an ASP.NET web application that connects to Azure Cache for Redis to store and retrieve data from the cache. You then deploy the app to Azure App Service.

Skip to the code on GitHub

Clone the repo https://github.com/Azure-Samples/azure-cache-redis-samples/tree/main/quickstart/aspnet on GitHub.

Prerequisites

::: zone pivot="azure-managed-redis"

Create an Azure Managed Redis (preview) instance

[!INCLUDE managed-redis-create]

::: zone-end

::: zone pivot="azure-cache-redis"

Create an Azure Cache for Redis instance

[!INCLUDE redis-cache-create]

::: zone-end

Microsoft Entra ID Authentication (recommended)

[!INCLUDE cache-entra-access]

Install the library for using Microsoft Entra ID Authentication

The Azure.StackExchange.Redis library contains the Microsoft using Microsoft Entra ID authentication method for connecting to Azure Redis services using Microsoft Entra ID. It's applicable to all Azure Cache for Redis, Azure Cache for Redis Enterprise, and Azure Managed Redis (Preview).

  1. Open your project in Visual Studio

  2. Right click on the project, choose Manage NuGet Packages...

  3. Search for Microsoft.Azure.StackExchangeRedis

  4. Click Install button to install

  5. Accept all prompted content to finish installation

Connect to the cache using Microsoft Entra ID

  1. Include the libraries in your code

    using Azure.Identity; using StackExchange.Redis

  2. Using the default Azure credentials to authenticate the client connection. This enables your code to use the signed-in user credential when running locally, and an Azure managed identity when running in Azure without code change.

varconfigurationOptions=awaitConfigurationOptions.Parse($"{_redisHostName}").ConfigureForAzureWithTokenCredentialAsync(newDefaultAzureCredential());ConnectionMultiplexer_newConnection=awaitConnectionMultiplexer.ConnectAsync(configurationOptions);IDatabaseDatabase=_newConnection.GetDatabase();

::: zone pivot="azure-managed-redis"

To edit the web.config file

  1. Edit the Web.config file by adding the following content:

    <appSettings> <addkey="RedisHostName"value="<cache-hostname-with-portnumber>"/> </appSettings>

  2. Replace <cache-hostname> with your cache host name as it appears in the Overview on the Resource menu in Azure portal.

    For example, with Azure Managed Redis or the Enterprise tiers: *my-redis.eastus.azure.net:10000_

  3. Save the file.

For more information, see StackExchange.Redis and the code in a GitHub repo.

::: zone-end

::: zone pivot="azure-cache-redis"

To edit the web.config file

  1. Edit the Web.config file by adding the following content:

    <appSettings> <addkey="RedisHostName"value="<cache-hostname-with-portnumber>"/> </appSettings>

  2. Replace <cache-hostname> with your cache host name as it appears in the Overview on the Resource menu in Azure portal.

    For example with Azure Cache for Redis, my-redis.eastus.azure.net:6380

  3. Save the file.

For more information, see StackExchange.Redis and the code in a GitHub repo.

::: zone-end

Run the app locally

By default, the project is configured to host the app locally in IIS Express for testing and debugging.

To run the app locally

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

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

  3. In the following example, the Message key previously had a cached value, which was set by using the Azure Cache for Redis console in the portal. The app updated that cached value. The app also executed the PING and CLIENT LIST commands.

    :::image type="content" source="media/web-app-cache-howto/cache-simple-test-complete-local.png" alt-text="Screenshot of simple test completed locally.":::

Publish and run in Azure

After you successfully test the app locally, you can deploy the app to Azure and run it in the cloud.

To publish the app to Azure

  1. In Visual Studio, right-click the project node in Solution Explorer. Then select Publish.

    :::image type="content" source="media/web-app-cache-howto/cache-publish-app.png" alt-text="Screenshot showing publish button.":::

  2. Select Microsoft Azure App Service, select Create New, and then select Publish.

    :::image type="content" source="media/web-app-cache-howto/cache-publish-to-app-service.png" alt-text="Screenshot showing how to publish to App Service.":::

  3. In the Create App Service dialog box, make the following changes:

    SettingRecommended valueDescription
    App nameUse the default.The app name is the host name for the app when deployed to Azure. The name might have a timestamp suffix added to it to make it unique if necessary.
    SubscriptionChoose your Azure subscription.This subscription is charged for any related hosting costs. If you have multiple Azure subscriptions, verify that the subscription that you want is selected.
    Resource groupUse the same resource group where you created the cache (for example, TestResourceGroup).The resource group helps you manage all resources as a group. Later, when you want to delete the app, you can just delete the group.
    App Service planSelect New, and then create a new App Service plan named TestingPlan.
    Use the same Location you used when creating your cache.
    Choose Free for the size.    		An App Service plan defines a set of compute resources for a web app to run with.

    :::image type="content" source="media/web-app-cache-howto/cache-create-app-service-dialog.png" alt-text="Screenshot showing the App Service dialog box.":::

  4. After you configure the App Service hosting settings, select Create.

  5. Monitor the Output window in Visual Studio to see the publishing status. After the app is published, the URL for the app is logged:

    :::image type="content" source="media/web-app-cache-howto/cache-publishing-output.png" alt-text="Screenshot publishing information in the output pane.":::

Add the app setting for the cache

After the new app is published, add a new app setting. This setting is used to store the cache connection information.

To add the app setting

  1. To find the new app you created, type the app name in the search bar at the top of the Azure portal.

    :::image type="content" source="media/web-app-cache-howto/cache-find-app-service.png" alt-text="Screenshot showing how to find the app on the Azure portal.":::

  2. Add a new app setting named CacheConnection for the app to use to connect to the cache. Use the same value you configured for RedisHostName in your web.config file.

Run the app in Azure

  1. In your browser, go to the URL for the app. The URL appears in the results of the publishing operation in the Visual Studio output window. The URL is also provided in the Azure portal on the overview page of the app you created.

  2. Select Azure Cache for Redis Test on the navigation bar to test cache access as you did with the local version.

[!INCLUDE cache-delete-resource-group]

Related content

close