整合 Azure Cache for Redis 與服務連接器

此頁面會顯示支援的驗證方法和用戶端，並顯示範例程式碼，您可以用來將 Azure Cache for Redis 連線到使用服務連接器的其他雲端服務。 在未使用服務連接器的情況下，您仍可透過其他程式設計語言連線至 Azure Cache for Redis。 此頁面也顯示您在建立服務連線時取得的預設環境變數名稱和值 (或 Spring Boot 設定)。

支援的計算服務

服務連接器可用來將下列計算服務連線至 Azure Cache for Redis：

• Azure App Service
• Azure 容器應用程式
• Azure Functions
• Azure Kubernetes Service (AKS)
• Azure Spring Apps

支援的驗證類型和用戶端類型

下表顯示使用服務連接器將計算服務連線到 Azure Cache for Redis 時，支援哪些驗證方法和用戶端組合。 「是」表示支援的組合，而「否」則表示不支援。

用戶端類型	系統指派的受控識別	使用者指派的受控識別	祕密 / 連接字串	服務主體
.NET	No	無	.是	No
Go	No	無	.是	No
Java	No	無	.是	No
Java - Spring Boot	No	無	.是	No
Node.js	No	無	.是	No
Python	No	無	.是	No
無	No	無	.是	No

下表會指出資料表中所有用戶端類型唯一支援的驗證方法是祕密 / 連接字串方法。 使用服務連接器連線到 Azure Cache for Redis 的任何用戶端類型都不支援其他驗證方法。

預設環境變數名稱或應用程式屬性和範例程式碼

使用下面所列的環境變數名稱和應用程式屬性，將計算服務連線到 Redis 伺服器。 針對以下每個範例，將預留位置文字 <redis-server-name> 和 <redis-key> 取代為您自己的 Redis 伺服器名稱和金鑰。 如需命名慣例的詳細資訊，請參閱服務連接器內部一文。

連接字串

警告

Microsoft 建議您使用最安全的可用驗證流程。 這個程序描述的驗證流程需要在應用程式中具備極高的信任度，且伴隨著其他流程並未面臨的風險。 請僅在其他較安全的流程 (例如受控身分識別) 皆不具可行性的情況下，才使用這個流程。

.NET

預設環境變數名稱	描述	範例值
AZURE_REDIS_CONNECTIONSTRING	StackExchange。 Redis 連接字串	<redis-server-name>.redis.cache.windows.net:6380,password=<redis-key>,ssl=True,defaultDatabase=0

Java

預設環境變數名稱	描述	範例值
AZURE_REDIS_CONNECTIONSTRING	Jedis 連接字串	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

SpringBoot

應用程式屬性	描述	範例值
spring.redis.host	Redis 主機	<redis-server-name>.redis.cache.windows.net
spring.redis.port	Redis 連接埠	6380
spring.redis.database	Redis 資料庫	0
spring.redis.password	Redis 金鑰	<redis-key>
spring.redis.ssl	SSL 設定	true

Python

預設環境變數名稱	描述	範例值
AZURE_REDIS_CONNECTIONSTRING	redis-py 連接字串	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

Go

預設環境變數名稱	描述	範例值
AZURE_REDIS_CONNECTIONSTRING	redis-py 連接字串	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

NodeJS

預設環境變數名稱	描述	範例值
AZURE_REDIS_CONNECTIONSTRING	node-redis 連接字串	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

其他

預設環境變數名稱	描述	範例值
AZURE_REDIS_HOST	Redis 主機	<redis-server-name>.redis.cache.windows.net
AZURE_REDIS_PORT	Redis 連接埠	6380
AZURE_REDIS_DATABASE	Redis 資料庫	0
AZURE_REDIS_PASSWORD	Redis 金鑰	<redis-key>
AZURE_REDIS_SSL	SSL 設定	true

範例指令碼

請參閱下面的步驟和程式碼，以使用連接字串來連線到 Azure Cache for Redis。

.NET

1. 安裝相依性。

   dotnet add package StackExchange.Redis --version 2.6.122
   

2. 從服務連接器新增的環境變數取得 Redis 連接字串。

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

Java

1. 在您的 pom.xml 中新增下列相依性：

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

2. 從服務連接器新增的環境變數取得 Redis 連接字串。

   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

請參閱在 Spring 中使用 Azure Cache for Redis 來設定 Spring 應用程式。 服務連接器會將組態屬性會新增至 Spring Apps。

Python

1. 安裝相依性。

   pip install redis
   

2. 從服務連接器新增的環境變數取得 Redis 連接字串。

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

Go

1. 安裝相依性。

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

2. 從服務連接器新增的環境變數取得 Redis 連接字串。

   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. 安裝相依性。

   npm install redis
   

2. 從服務連接器新增的環境變數取得 Redis 連接字串。

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

其他

對於其他語言，您可以使用服務連接器設定到環境變數的連線資訊，來連線到 Azure Cache for Redis。 如需環境變數詳細資訊，請參閱使用服務連接器整合 Azure 應用程式組態。

下一步

請遵循下方列出的教學課程以深入了解服務連接器。

了解服務連接器概念