This quickstart shows you how to get started using Microsoft Azure Redis Cache with .NET Core. Microsoft Azure Redis Cache is based on the popular open-source Redis Cache. It gives you access to a secure, dedicated Redis cache, managed by Microsoft. A cache created using Azure Redis Cache is accessible from any application within Microsoft Azure.
In this quickstart, you will use the StackExchange.Redis client with C# code in a .NET Core console app. You will create a cache, configure the .NET Core client app. Then, you will add, and update objects in the cache.
You can use any code editor to complete the steps in this quickstart. However, Visual Studio Code is an excellent option available on the Windows, macOS, and Linux platforms.
If you don’t have an Azure subscription, create a free account before you begin.
Create a cache
To create a cache, first sign in to the Azure portal, and click Create a resource > Databases > Redis Cache.
In New Redis Cache, configure the settings for your new cache.
|DNS name||Globally unique name||The cache name must be a string between 1 and 63 characters and contain only numbers, letters, and the
|Subscription||Your subscription||The subscription under which this new Azure Redis Cache is created.|
|Resource Group||TestResources||Name for the new resource group in which to create your cache. By putting all the resources for an app in a group, you can manage them together. For example, deleting the resource group would delete all resources associated with the app.|
|Location||East US||Choose a region near to other services that will use your cache.|
|Pricing tier||Basic C0 (250 MB Cache)||The pricing tier determines the size, performance, and features available for the cache. For more information, see Azure Redis Cache Overview.|
|Pin to dashboard||Selected||Click pin the new cache to your dashboard making it easy to find.|
Once the new cache settings are configured, click Create.
It can take a few minutes for the cache to be created. To check the status, you can monitor the progress on the dashboard. After the cache has been created, your new cache has a Running status and is ready for use.
Retrieve host name, ports, and access keys using the Azure Portal
When connecting to an Azure Redis Cache instance, cache clients need the host name, ports, and a key for the cache. Some clients may refer to these items by slightly different names. You can retrieve this information in the Azure portal.
To retrieve the access keys using the Azure portal, browse to your cache and click Access keys.
To retrieve host name, ports, click Properties.
Make a note of the HOST NAME and the Primary access key. You will use these values later to construct the CacheConnection secret.
Create a console app
Open a new command window and execute the following command to create a new .NET Core console app:
dotnet new console -o Redistest
In your command window, change to the new Redistest project directory.
Add Secret Manager to the project
In this section, you will add the Secret Manager tool to your project. The Secret Manager tool stores sensitive data for development work outside of your project tree. This approach helps prevent the accidental sharing of app secrets within source code.
Open your Redistest.csproj file. Add a
DotNetCliToolReference element to include Microsoft.Extensions.SecretManager.Tools. Also add a
UserSecretsId element as shown below, and save the file.
<Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <OutputType>Exe</OutputType> <TargetFramework>netcoreapp2.0</TargetFramework> <UserSecretsId>Redistest</UserSecretsId> </PropertyGroup> <ItemGroup> <DotNetCliToolReference Include="Microsoft.Extensions.SecretManager.Tools" Version="2.0.0" /> </ItemGroup> </Project>
Execute the following command to add the Microsoft.Extensions.Configuration.UserSecrets package to the project:
dotnet add package Microsoft.Extensions.Configuration.UserSecrets
Execute the following command to restore your packages:
In your command window, execute the following command to store a new secret named CacheConnection, after replacing the placeholders (including angle brackets) for your cache name and primary access key:
dotnet user-secrets set CacheConnection "<cache name>.redis.cache.windows.net,abortConnect=false,ssl=true,password=<primary-access-key>"
Add the following
using statement to Program.cs:
Add the following members to the
Program class in Program.cs. This code initializes a configuration to access the user secret for the redis cache connection string.
private static IConfigurationRoot Configuration get; set; const string SecretName = "CacheConnection"; private static void InitializeConfiguration() var builder = new ConfigurationBuilder() .AddUserSecrets<Program>(); Configuration = builder.Build();
Configure the cache client
In this section, you will configure the console application to use the StackExchange.Redis client for .NET.
In your command window, execute the following command in the Redistest project directory:
dotnet add package StackExchange.Redis
Once the installation is completed, the StackExchange.Redis cache client is available to use with your project.
Connect to the cache
Add the following
using statement to Program.cs:
The connection to the Azure Redis Cache is managed by the
ConnectionMultiplexer class. This class should be shared and reused throughout your client application. Do not create a new connection for each operation.
In Program.cs, add the following members to the
Program class of your console application:
private static Lazy<ConnectionMultiplexer> lazyConnection = new Lazy<ConnectionMultiplexer>(() => string cacheConnection = Configuration[SecretName]; return ConnectionMultiplexer.Connect(cacheConnection); ); public static ConnectionMultiplexer Connection get return lazyConnection.Value;
This approach to sharing a
ConnectionMultiplexer instance in your application uses a static property that returns a connected instance. The code provides a thread-safe way to initialize only a single connected
abortConnect is set to false, which means that the call succeeds even if a connection to the Azure Redis Cache is not established. One key feature of
ConnectionMultiplexer is that it automatically restores connectivity to the cache once the network issue or other causes are resolved.
The value of the CacheConnection secret is accessed using the Secret Manager configuration provider and used as the password parameter.
Executing cache commands
In Program.cs, add the following code for the
Main procedure of the
Program class for your console application:
static void Main(string args) InitializeConfiguration(); // Connection refers to a property that returns a ConnectionMultiplexer // as shown in the previous example. IDatabase cache = lazyConnection.Value.GetDatabase(); // Perform cache operations using the cache object... // Simple PING command string cacheCommand = "PING"; Console.WriteLine("nCache command : " + cacheCommand); Console.WriteLine("Cache response : " + cache.Execute(cacheCommand).ToString()); // Simple get and put of integral data types into the cache cacheCommand = "GET Message"; Console.WriteLine("nCache command : " + cacheCommand + " or StringGet()"); Console.WriteLine("Cache response : " + cache.StringGet("Message").ToString()); cacheCommand = "SET Message "Hello! The cache is working from a .NET Core console app!""; Console.WriteLine("nCache command : " + cacheCommand + " or StringSet()"); Console.WriteLine("Cache response : " + cache.StringSet("Message", "Hello! The cache is working from a .NET Core console app!").ToString()); // Demostrate "SET Message" executed as expected... cacheCommand = "GET Message"; Console.WriteLine("nCache command : " + cacheCommand + " or StringGet()"); Console.WriteLine("Cache response : " + cache.StringGet("Message").ToString()); // Get the client list, useful to see if connection list is growing... cacheCommand = "CLIENT LIST"; Console.WriteLine("nCache command : " + cacheCommand); Console.WriteLine("Cache response : n" + cache.Execute("CLIENT", "LIST").ToString().Replace("id=", "id=")); lazyConnection.Value.Dispose();
Azure Redis caches have a configurable number of databases (default of 16) that can be used to logically separate the data within a Redis cache. The code connects to the default database, DB 0. For more information, see What are Redis databases? and Default Redis server configuration.
Cache items can be stored and retrieved by using the
Redis stores most data as Redis strings, but these strings can contain many types of data, including serialized binary data, which can be used when storing .NET objects in the cache.
Execute the following command in your command window to build the app:
Then run the app with the following command:
In the example below, you can see the
Message key previously had a cached value, which was set using the Redis Console in the Azure portal. The app updated that cached value. The app also executed the
CLIENT LIST commands.
Work with .NET objects in the cache
Azure Redis Cache can cache both .NET objects and primitive data types, but before a .NET object can be cached it must be serialized. This .NET object serialization is the responsibility of the application developer, and gives the developer flexibility in the choice of the serializer.
One simple way to serialize objects is to use the
JsonConvert serialization methods in Newtonsoft.Json and serialize to and from JSON. In this section, you will add a .NET object to the cache.
Execute the following command to add the Newtonsoft.json package to the app:
dotnet add package Newtonsoft.json
Add the following
using statement to the top of Program.cs:
Add the following
Employee class definition to Program.cs:
class Employee public string Id get; set; public string Name get; set; public int Age get; set; public Employee(string EmployeeId, string Name, int Age) this.Id = EmployeeId; this.Name = Name; this.Age = Age;
At the bottom of
Main() procedure in Program.cs, and before the call to
Dispose(), add the following lines of code to cache and retrieve a serialized .NET object:
// Store .NET object to cache Employee e007 = new Employee("007", "Davide Columbo", 100); Console.WriteLine("Cache response from storing Employee .NET object : " + cache.StringSet("e007", JsonConvert.SerializeObject(e007))); // Retrieve .NET object from cache Employee e007FromCache = JsonConvert.DeserializeObject<Employee>(cache.StringGet("e007")); Console.WriteLine("Deserialized Employee .NET object :n"); Console.WriteLine("tEmployee.Name : " + e007FromCache.Name); Console.WriteLine("tEmployee.Id : " + e007FromCache.Id); Console.WriteLine("tEmployee.Age : " + e007FromCache.Age + "n");
Save Program.cs and rebuild the app with the following command:
Run the app with the following command to test serialization of .NET objects:
Clean up resources
If you will be continuing to the next tutorial, you can keep the resources created in this quickstart and reuse them.
Otherwise, if you are finished with the quickstart sample application, you can delete the Azure resources created in this quickstart to avoid charges.
Deleting a resource group is irreversible and that the resource group and all the resources in it are permanently deleted. Make sure that you do not accidentally delete the wrong resource group or resources. If you created the resources for hosting this sample inside an existing resource group that contains resources you want to keep, you can delete each resource individually from their respective blades instead of deleting the resource group.
Sign in to the Azure portal and click Resource groups.
In the Filter by name… textbox, type the name of your resource group. The instructions for this article used a resource group named TestResources. On your resource group in the result list, click … then Delete resource group.
You will be asked to confirm the deletion of the resource group. Type the name of your resource group to confirm, and click Delete.
After a few moments, the resource group and all of its contained resources are deleted.
In this quickstart, you learned how to use Azure Redis Cache from a .NET Core application. Continue to the next quickstart to use Redis Cache with an ASP.NET web app.