Integrate Azure Cache for Redis with Service Connector

This page shows supported authentication methods and clients, and shows sample code you can use to connect Azure Cache for Redis to other cloud services using Service Connector. You might still be able to connect to Azure Cache for Redis in other programming languages without using Service Connector. This page also shows default environment variable names and values (or Spring Boot configuration) you get when you create the service connection.

Supported compute services

Service Connector can be used to connect the following compute services to Azure Cache for Redis:

• Azure App Service
• Azure Container Apps
• Azure Functions
• Azure Kubernetes Service (AKS)
• Azure Spring Apps

Supported Authentication types and client types

The table below shows which combinations of authentication methods and clients are supported for connecting your compute service to Azure Cache for Redis using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported.

Client type	System-assigned managed identity	User-assigned managed identity	Secret / connection string	Service principal
.NET	No	No	Yes	No
Go	No	No	Yes	No
Java	No	No	Yes	No
Java - Spring Boot	No	No	Yes	No
Node.js	No	No	Yes	No
Python	No	No	Yes	No
None	No	No	Yes	No

This table indicates that the only supported authentication method for all client types in the table is the Secret / connection string method. Other authentication methods are not supported for any of the client types to connect to Azure Cache for Redis using Service Connector.

Default environment variable names or application properties and sample code

Use the environment variable names and application properties listed below to connect compute services to Redis Server. For each example below, replace the placeholder texts <redis-server-name>, and <redis-key> with your own Redis server name and key. For more information about naming conventions, check the Service Connector internals article.

Connection String

Warning

Microsoft recommends that you use the most secure authentication flow available. The authentication flow described in this procedure requires a very high degree of trust in the application, and carries risks that are not present in other flows. You should only use this flow when other more secure flows, such as managed identities, aren't viable.

.NET

Default environment variable name	Description	Example value
AZURE_REDIS_CONNECTIONSTRING	StackExchange. Redis connection string	<redis-server-name>.redis.cache.windows.net:6380,password=<redis-key>,ssl=True,defaultDatabase=0

Java

Default environment variable name	Description	Example value
AZURE_REDIS_CONNECTIONSTRING	Jedis connection string	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

SpringBoot

Application properties	Description	Example value
spring.redis.host	Redis host	<redis-server-name>.redis.cache.windows.net
spring.redis.port	Redis port	6380
spring.redis.database	Redis database	0
spring.redis.password	Redis key	<redis-key>
spring.redis.ssl	SSL setting	true

Python

Default environment variable name	Description	Example value
AZURE_REDIS_CONNECTIONSTRING	redis-py connection string	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

Go

Default environment variable name	Description	Example value
AZURE_REDIS_CONNECTIONSTRING	redis-py connection string	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

NodeJS

Default environment variable name	Description	Example value
AZURE_REDIS_CONNECTIONSTRING	node-redis connection string	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

Other

Default environment variable name	Description	Example value
AZURE_REDIS_HOST	Redis host	<redis-server-name>.redis.cache.windows.net
AZURE_REDIS_PORT	Redis port	6380
AZURE_REDIS_DATABASE	Redis database	0
AZURE_REDIS_PASSWORD	Redis key	<redis-key>
AZURE_REDIS_SSL	SSL setting	true

Sample code

Refer to the steps and code below to connect to Azure Cache for Redis using a connection string.

.NET

1. Install dependencies.

   dotnet add package StackExchange.Redis --version 2.6.122
   

2. Get the Redis connection string from the environment variable added by Service Connector.

   using StackExchange.Redis;
   var connectionString = Environment.GetEnvironmentVariable("AZURE_REDIS_CONNECTIONSTRING");
   var _redisConnection = await RedisConnection.InitializeAsync(connectionString: connectionString);
   

Java

1. Add the following dependency in your pom.xml file:

   <dependency>
     <groupId>redis.clients</groupId>
     <artifactId>jedis</artifactId>
     <version>4.1.0</version>
     <type>jar</type>
     <scope>compile</scope>
   </dependency>
   

2. Get the Redis connection string from the environment variable added by Service Connector.

   import redis.clients.jedis.DefaultJedisClientConfig;
   import redis.clients.jedis.Jedis;
   import redis.clients.jedis.JedisShardInfo;
   import java.net.URI;
   
   String connectionString = System.getenv("AZURE_REDIS_CONNECTIONSTRING");
   URI uri = new URI(connectionString);
   JedisShardInfo shardInfo = new JedisShardInfo(uri);
   shardInfo.setSsl(true);
   Jedis jedis = new Jedis(shardInfo);
   

SpringBoot

Refer to Use Azure Redis Cache in Spring to set up your Spring application. The configuration properties are added to Spring Apps by Service Connector.

Python

1. Install dependencies.

   pip install redis
   

2. Get the Redis connection string from the environment variable added by Service Connector.

   import os
   import redis
   
   url = os.getenv('AZURE_REDIS_CONNECTIONSTRING')
   url_connection = redis.from_url(url)
   url_connection.ping()
   

Go

1. Install dependencies.

   go get github.com/redis/go-redis/v9
   

2. Get the Redis connection string from the environment variable added by Service Connector.

   import (
       "context"
       "fmt"
   
       "github.com/redis/go-redis/v9"
   )
   
   connectionString := os.Getenv("AZURE_REDIS_CONNECTIONSTRING")
   opt, err := redis.ParseURL(connectionString)
   if err != nil {
   	panic(err)
   }
   
   client := redis.NewClient(opt)
   

NodeJS

1. Install dependencies.

   npm install redis
   

2. Get the Redis connection string from the environment variable added by Service Connector.

   const redis = require("redis");
   
   const connectionString = process.env.AZURE_REDIS_CONNECTIONSTRING;
   const cacheConnection = redis.createClient({
       url: connectionString,
   });
   await cacheConnection.connect();
   

Other

For other languages, you can use the connection information that Service Connector sets to the environment variables to connect to Azure Cache for Redis. For environment variable details, see Integrate Azure App Configuration with Service Connector.

Next steps

Follow the tutorials listed below to learn more about Service Connector.

Learn about Service Connector concepts