Skip to content

Latest commit

 

History

History

MemoryCacheAndRedisProvider

README.md

Using in-memory and Azure cache for Redis

Here, we'll cover how we can use in-memory caching technique methods and to cache the pipeline output data to Redis on Azure.

Since we are using Redis, we can use non-persistent hosts (like Azure Functions) for this caching approach. The memory cache will only work for a single host, but the Redis cache will work across hosts.

Concepts

This sample provides easy configuration steps to cache the pipeline data to in-memory and on Azure Redis.

Prerequisites

  • This repository cloned to your machine and an editor (e.g. Visual Studio or Visual Studio Code).
  • .NET 8.0 SDK downloaded and installed on your computer.
  • An authenticated Azure environment.
    • Usually you need to be logged in with the Azure CLI.
    • You also cae be logged into Azure inside Visual Studio or Visual Studio Code.
  • You will need an Azure Cache for Redis resource.

Setup your environment

This sample needs to be configured with the Azure Cache for Redis to start. You can configure this either in Visual Studio or by using the command line.

Command line

Run this below command to set up the sample configuration in the dotnet secret store.

  • Open a command prompt and navigate to samples\MemoryCacheAndRedisProvider inside of this repository.

    dotnet user-secrets init
dotnet user-secrets set "ConnectionString" "<<Your Redis Connection string>>"

Visual Studio

If you are using Visual Studio, you can setup configuration via secrets without using the command line.

  1. Right-click on the MemoryCacheAndRedisProvider solution in the Solution Explorer and choose "Manage User Secrets".
  2. An editor for secrets.json will open. Paste the below inside of this file.
  {
    "ConnectionString": "<Your Redis Connection string>"
  }
  1. Save and close secrets.json.

Build the sample

  • If you are using Microsoft Visual Studio, press Ctrl+Shift+B, or select Build > Build Solution

  • If you are using the .NET Core CLI, run the following command from the directory that contains this sample:

dotnet build

Run the sample

  • To debug the app and then run it, press F5 or use Debug > Start Debugging. To run the app without debugging, press Ctrl+F5 or use Debug > Start Without Debugging.

  • Using the .NET Core CLI

    Run the following command from the directory that contains this sample:

    dotnet run

Usage details

  • Program.cs file outlines how you can implement the caching and store the data in Azure Redis.

  • AddMemoryCache: Please refer to this .NET documentation page for more information.

  • Option Pattern uses classes to provide strongly typed access to groups of related settings. Look at this .NET documentation page for more information.

  • SetAsync: This method internally calls IJsonObjectCache interface which is part of the toolkit. It will create a record with the given key in Redis.

  • GetAsync: This method will read the data from Redis, DeserializeObject it. To read the data, you will need to pass the key name as a parameter.