Integrieren von Azure Cache for Redis in Service Connector

Sie können Azure Cache for Redis mit anderen Clouddiensten verbinden, indem Sie Dienstconnector verwenden. Dieser Artikel beschreibt unterstützte Authentifizierungsmethoden und Clients und stellt Beispielcode bereit. Es werden auch die Namen und Werte der Standardumgebungsvariablen (oder die Spring Boot-Konfiguration) angezeigt, die Sie erhalten, wenn Sie die Dienstverbindung erstellen.

Unterstützte Computedienste

Mit Dienstconnector können Sie die folgenden Computedienste mit Azure Cache for Redis verbinden:

• Azure App Service
• Azure Container Apps
• Azure-Funktionen
• Azure Kubernetes Service (AKS)
• Azure Spring Apps

Unterstützte Authentifizierungs- und Clienttypen

Die folgende Tabelle zeigt, welche Kombinationen von Authentifizierungsmethoden und Clients für die Verbindung Ihres Computediensts mit Azure Cache for Redis mithilfe von Dienstconnector unterstützt werden. „Ja“ bedeutet, dass die Kombination unterstützt wird. „Nein“ bedeutet, dass sie nicht unterstützt wird.

Clienttyp	Systemseitig zugewiesene verwaltete Identität	Benutzerseitig zugewiesene verwaltete Identität	Geheimnis/Verbindungszeichenfolge	Dienstprinzipal
.NET	Ja	Ja	Ja	Ja
Go	No	Nein	Ja	No
Java	Ja	Ja	Ja	Ja
Java - Spring Boot	No	Nein	Ja	No
Node.js	Ja	Ja	Ja	Ja
Python	Ja	Ja	Ja	Ja
Keine	Ja	Ja	Ja	Ja

Alle Clienttypen, mit Ausnahme von Go und Java – Spring Boot, können alle in der Tabelle aufgeführten Authentifizierungsmethoden verwenden, um mithilfe von Dienstconnector eine Verbindung mit Azure Cache for Redis herzustellen. Die einzigen unterstützten Authentifizierungsmethoden für Go und Java – Spring Boot sind Geheimnis/Verbindungszeichenfolge oder Dienstprinzipal.

Namen von Standard-Umgebungsvariablen oder Anwendungseigenschaften und Beispielcode

Verwenden Sie die folgenden Umgebungsvariablennamen und Anwendungseigenschaften, um Computedienste mit Ihrem Redis-Server zu verbinden. Um mehr über Benennungskonventionen zu erfahren, lesen Sie den Artikel Dienstconnector-Interna.

Systemseitig zugewiesene verwaltete Identität

Standardname der Umgebungsvariablen	Beschreibung	Beispielwert
AZURE_REDIS_HOST	Redis-Endpunkt	<RedisName>.redis.cache.windows.net

Beispielcode

Die folgenden Schritte und der folgende Code zeigen Ihnen, wie Sie eine systemseitig zugewiesene verwaltete Identität verwenden, um eine Verbindung mit Redis herzustellen.

.NET

1. Installieren Sie Abhängigkeiten.

   dotnet add package Microsoft.Azure.StackExchangeRedis --version 3.2.0
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter der Microsoft.Azure.StackExchangeRedis-Erweiterung.

   using StackExchange.Redis;
   var cacheHostName = Environment.GetEnvironmentVariable("AZURE_REDIS_HOST");
   var configurationOptions = ConfigurationOptions.Parse($"{cacheHostName}:6380");
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // await configurationOptions.ConfigureForAzureWithTokenCredentialAsync(new DefaultAzureCredential());
   
   // For user-assigned identity.
   // var managedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTID");
   // await configurationOptions.ConfigureForAzureWithUserAssignedManagedIdentityAsync(managedIdentityClientId);
   
   // Service principal secret.
   // var clientId = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTID");
   // var tenantId = Environment.GetEnvironmentVariable("AZURE_REDIS_TENANTID");
   // var secret = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTSECRET");
   // await configurationOptions.ConfigureForAzureWithServicePrincipalAsync(clientId, tenantId, secret);
   
   
   var connectionMultiplexer = await ConnectionMultiplexer.ConnectAsync(configurationOptions);
   

Java

1. Fügen Sie Ihrer Datei pom.xml die folgende Abhängigkeit hinzu:

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.11.2</version> <!-- {x-version-update;com.azure:azure-identity;dependency} -->
   </dependency>
   
   <dependency>
       <groupId>redis.clients</groupId>
       <artifactId>jedis</artifactId>
       <version>5.1.0</version>  <!-- {x-version-update;redis.clients:jedis;external_dependency} -->
   </dependency>
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter Azure-AAD-Authentication-With-Jedis.

   import redis.clients.jedis.DefaultJedisClientConfig;
   import redis.clients.jedis.Jedis;
   import redis.clients.jedis.JedisShardInfo;
   import java.net.URI;
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().build();
   
   // For user-assigned identity.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().managedIdentityClientId(clientId).build();
   
   // For AKS workload identity.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().workloadIdentityClientId(clientId).build();
   
   // For service principal.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // String secret = System.getenv("AZURE_REDIS_CLIENTSECRET");
   // String tenant = System.getenv("AZURE_REDIS_TENANTID");
   // ClientSecretCredential defaultAzureCredential = new ClientSecretCredentialBuilder().tenantId(tenant).clientId(clientId).clientSecret(secret).build();
   
   String token = defaultAzureCredential
   .getToken(new TokenRequestContext()
       .addScopes("https://redis.azure.com/.default")).block().getToken();
   
   // SSL connection is required.
   boolean useSsl = true;
   // TODO: Replace Host Name with Azure Cache for Redis Host Name.
   String username = extractUsernameFromToken(token);
   String cacheHostname = System.getenv("AZURE_REDIS_HOST");
   
   // Create Jedis client and connect to Azure Cache for Redis over the TLS/SSL port using the access token as password.
   // Note, Redis Cache host name and port are required below.
   Jedis jedis = new Jedis(cacheHostname, 6380, DefaultJedisClientConfig.builder()
       .password(token) // Microsoft Entra access token as password is required.
       .user(username) // Username is Required
       .ssl(useSsl) // SSL Connection is Required
       .build());
   
   // Set a value against your key in the Redis cache.
   jedis.set("Az:key", "testValue");
   System.out.println(jedis.get("Az:key"));
   
   // Close the Jedis Client
   jedis.close();
   

Spring Boot

Wird noch nicht unterstützt.

Python

1. Installieren Sie Abhängigkeiten.

   pip install redis azure-identity
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter azure-aad-auth-with-redis-py.

   import os
   import time
   import logging
   import redis
   import base64
   import json
   from azure.identity import DefaultAzureCredential
   
   host = os.getenv('AZURE_REDIS_HOST')
   scope = "https://redis.azure.com/.default"
   port = 6380  # Required
   
   def extract_username_from_token(token):
       parts = token.split('.')
       base64_str = parts[1]
   
       if len(base64_str) % 4 == 2:
           base64_str += "=="
       elif len(base64_str) % 4 == 3:
           base64_str += "="
   
       json_bytes = base64.b64decode(base64_str)
       json_str = json_bytes.decode('utf-8')
       jwt = json.loads(json_str)
   
       return jwt['oid']
   
   def re_authentication():
       _LOGGER = logging.getLogger(__name__)
       # Uncomment the following lines corresponding to the authentication type you want to use.
       # For system-assigned identity.
       # cred = DefaultAzureCredential()
   
       # For user-assigned identity.
       # client_id = os.getenv('AZURE_REDIS_CLIENTID')
       # cred = DefaultAzureCredential(managed_identity_client_id=client_id)
   
       # For user-assigned identity.
       # client_id = os.getenv('AZURE_REDIS_CLIENTID')
       # cred = DefaultAzureCredential(managed_identity_client_id=client_id)
   
       # For service principal.
       # tenant_id = os.getenv("AZURE_TENANT_ID")
       # client_id = os.getenv("AZURE_CLIENT_ID")
       # client_secret = os.getenv("AZURE_CLIENT_SECRET")
       # cred = ServicePrincipalCredentials(tenant=tenant_id, client_id=client_id, secret=client_secret)
   
       token = cred.get_token(scope)
       user_name = extract_username_from_token(token.token)
       r = redis.Redis(host=host,
                       port=port,
                       ssl=True,   # ssl connection is required.
                       username=user_name,
                       password=token.token,
                       decode_responses=True)
       max_retry = 3
       for index in range(max_retry):
           try:
               if _need_refreshing(token):
                   _LOGGER.info("Refreshing token...")
                   tmp_token = cred.get_token(scope)
                   if tmp_token:
                       token = tmp_token
                   r.execute_command("AUTH", user_name, token.token)
               r.set("Az:key1", "value1")
               t = r.get("Az:key1")
               print(t)
               break
           except redis.ConnectionError:
               _LOGGER.info("Connection lost. Reconnecting.")
               token = cred.get_token(scope)
               r = redis.Redis(host=host,
                               port=port,
                               ssl=True,   # ssl connection is required.
                               username=user_name,
                               password=token.token,
                               decode_responses=True)
           except Exception:
               _LOGGER.info("Unknown failures.")
               break
   
   
   def _need_refreshing(token, refresh_offset=300):
       return not token or token.expires_on - time.time() < refresh_offset
   
   if __name__ == '__main__':
       re_authentication()
   

Go

Wird noch nicht unterstützt.

Node.js

1. Installieren Sie Abhängigkeiten.

   npm install redis @azure/identity
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter Azure Cache for Redis: Microsoft Entra ID mit der Clientbibliothek „node-redis“.

   import { createClient } from "redis";
   import { DefaultAzureCredential } from "@azure/identity";
   
   function extractUsernameFromToken(accessToken: AccessToken): string{
       const base64Metadata = accessToken.token.split(".")[1];
       const { oid } = JSON.parse(
           Buffer.from(base64Metadata, "base64").toString("utf8"),
       );
       return oid;
   }
   
   async function main() {
       // Uncomment the following lines corresponding to the authentication type you want to use.  
       // For system-assigned identity.
       // const credential = new DefaultAzureCredential();
   
       // For user-assigned identity.
       // const clientId = process.env.AZURE_REDIS_CLIENTID;
       // const credential = new DefaultAzureCredential({
       //     managedIdentityClientId: clientId
       // });
   
       // For service principal.
       // const tenantId = process.env.AZURE_REDIS_TENANTID;
       // const clientId = process.env.AZURE_REDIS_CLIENTID;
       // const clientSecret = process.env.AZURE_REDIS_CLIENTSECRET;
       // const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
   
       // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
       const redisScope = "https://redis.azure.com/.default";
       let accessToken = await credential.getToken(redisScope);
       console.log("access Token", accessToken);
       const host = process.env.AZURE_REDIS_HOST;
   
       // Create redis client and connect to Azure Cache for Redis over the TLS port using the access token as password.
       const client = createClient({
           username: extractUsernameFromToken(accessToken),
           password: accessToken.token,
           url: `redis://${host}:6380`,
           pingInterval: 100000,
           socket: { 
           tls: true,
           keepAlive: 0 
           },
       });
   
       client.on("error", (err) => console.log("Redis Client Error", err));
       await client.connect();
       // Set a value against your key in Azure Redis Cache.
       await client.set("Az:key", "value1312");
       // Get value of your key in Azure Redis Cache.
       console.log("value-", await client.get("Az:key"));
   }
   
   main().catch((err) => {
       console.log("error code: ", err.code);
       console.log("error message: ", err.message);
       console.log("error stack: ", err.stack);
   });
   

Andere

Für andere Sprachen können Sie die Azure-Identitätsclientbibliothek verwenden (und Verbindungsinformationen, die der Dienstconnector auf die Umgebungsvariablen festlegt), um eine Verbindung mit Azure Cache for Redis herzustellen.

Benutzerseitig zugewiesene verwaltete Identität

Standardname der Umgebungsvariablen	Beschreibung	Beispielwert
AZURE_REDIS_HOST	Redis-Endpunkt	<RedisName>.redis.cache.windows.net
AZURE_REDIS_CLIENTID	Client-ID der verwalteten Identität	<client-ID>

Beispielcode

Die folgenden Schritte und der folgende Code zeigen Ihnen, wie Sie eine benutzerseitig zugewiesene verwaltete Identität verwenden, um eine Verbindung mit Redis herzustellen.

.NET

1. Installieren Sie Abhängigkeiten.

   dotnet add package Microsoft.Azure.StackExchangeRedis --version 3.2.0
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter der Microsoft.Azure.StackExchangeRedis-Erweiterung.

   using StackExchange.Redis;
   var cacheHostName = Environment.GetEnvironmentVariable("AZURE_REDIS_HOST");
   var configurationOptions = ConfigurationOptions.Parse($"{cacheHostName}:6380");
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // await configurationOptions.ConfigureForAzureWithTokenCredentialAsync(new DefaultAzureCredential());
   
   // For user-assigned identity.
   // var managedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTID");
   // await configurationOptions.ConfigureForAzureWithUserAssignedManagedIdentityAsync(managedIdentityClientId);
   
   // Service principal secret.
   // var clientId = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTID");
   // var tenantId = Environment.GetEnvironmentVariable("AZURE_REDIS_TENANTID");
   // var secret = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTSECRET");
   // await configurationOptions.ConfigureForAzureWithServicePrincipalAsync(clientId, tenantId, secret);
   
   
   var connectionMultiplexer = await ConnectionMultiplexer.ConnectAsync(configurationOptions);
   

Java

1. Fügen Sie Ihrer Datei pom.xml die folgende Abhängigkeit hinzu:

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.11.2</version> <!-- {x-version-update;com.azure:azure-identity;dependency} -->
   </dependency>
   
   <dependency>
       <groupId>redis.clients</groupId>
       <artifactId>jedis</artifactId>
       <version>5.1.0</version>  <!-- {x-version-update;redis.clients:jedis;external_dependency} -->
   </dependency>
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter Azure-AAD-Authentication-With-Jedis.

   import redis.clients.jedis.DefaultJedisClientConfig;
   import redis.clients.jedis.Jedis;
   import redis.clients.jedis.JedisShardInfo;
   import java.net.URI;
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().build();
   
   // For user-assigned identity.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().managedIdentityClientId(clientId).build();
   
   // For AKS workload identity.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().workloadIdentityClientId(clientId).build();
   
   // For service principal.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // String secret = System.getenv("AZURE_REDIS_CLIENTSECRET");
   // String tenant = System.getenv("AZURE_REDIS_TENANTID");
   // ClientSecretCredential defaultAzureCredential = new ClientSecretCredentialBuilder().tenantId(tenant).clientId(clientId).clientSecret(secret).build();
   
   String token = defaultAzureCredential
   .getToken(new TokenRequestContext()
       .addScopes("https://redis.azure.com/.default")).block().getToken();
   
   // SSL connection is required.
   boolean useSsl = true;
   // TODO: Replace Host Name with Azure Cache for Redis Host Name.
   String username = extractUsernameFromToken(token);
   String cacheHostname = System.getenv("AZURE_REDIS_HOST");
   
   // Create Jedis client and connect to Azure Cache for Redis over the TLS/SSL port using the access token as password.
   // Note, Redis Cache host name and port are required below.
   Jedis jedis = new Jedis(cacheHostname, 6380, DefaultJedisClientConfig.builder()
       .password(token) // Microsoft Entra access token as password is required.
       .user(username) // Username is Required
       .ssl(useSsl) // SSL Connection is Required
       .build());
   
   // Set a value against your key in the Redis cache.
   jedis.set("Az:key", "testValue");
   System.out.println(jedis.get("Az:key"));
   
   // Close the Jedis Client
   jedis.close();
   

Spring Boot

Wird noch nicht unterstützt.

Python

1. Installieren Sie Abhängigkeiten.

   pip install redis azure-identity
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter azure-aad-auth-with-redis-py.

   import os
   import time
   import logging
   import redis
   import base64
   import json
   from azure.identity import DefaultAzureCredential
   
   host = os.getenv('AZURE_REDIS_HOST')
   scope = "https://redis.azure.com/.default"
   port = 6380  # Required
   
   def extract_username_from_token(token):
       parts = token.split('.')
       base64_str = parts[1]
   
       if len(base64_str) % 4 == 2:
           base64_str += "=="
       elif len(base64_str) % 4 == 3:
           base64_str += "="
   
       json_bytes = base64.b64decode(base64_str)
       json_str = json_bytes.decode('utf-8')
       jwt = json.loads(json_str)
   
       return jwt['oid']
   
   def re_authentication():
       _LOGGER = logging.getLogger(__name__)
       # Uncomment the following lines corresponding to the authentication type you want to use.
       # For system-assigned identity.
       # cred = DefaultAzureCredential()
   
       # For user-assigned identity.
       # client_id = os.getenv('AZURE_REDIS_CLIENTID')
       # cred = DefaultAzureCredential(managed_identity_client_id=client_id)
   
       # For user-assigned identity.
       # client_id = os.getenv('AZURE_REDIS_CLIENTID')
       # cred = DefaultAzureCredential(managed_identity_client_id=client_id)
   
       # For service principal.
       # tenant_id = os.getenv("AZURE_TENANT_ID")
       # client_id = os.getenv("AZURE_CLIENT_ID")
       # client_secret = os.getenv("AZURE_CLIENT_SECRET")
       # cred = ServicePrincipalCredentials(tenant=tenant_id, client_id=client_id, secret=client_secret)
   
       token = cred.get_token(scope)
       user_name = extract_username_from_token(token.token)
       r = redis.Redis(host=host,
                       port=port,
                       ssl=True,   # ssl connection is required.
                       username=user_name,
                       password=token.token,
                       decode_responses=True)
       max_retry = 3
       for index in range(max_retry):
           try:
               if _need_refreshing(token):
                   _LOGGER.info("Refreshing token...")
                   tmp_token = cred.get_token(scope)
                   if tmp_token:
                       token = tmp_token
                   r.execute_command("AUTH", user_name, token.token)
               r.set("Az:key1", "value1")
               t = r.get("Az:key1")
               print(t)
               break
           except redis.ConnectionError:
               _LOGGER.info("Connection lost. Reconnecting.")
               token = cred.get_token(scope)
               r = redis.Redis(host=host,
                               port=port,
                               ssl=True,   # ssl connection is required.
                               username=user_name,
                               password=token.token,
                               decode_responses=True)
           except Exception:
               _LOGGER.info("Unknown failures.")
               break
   
   
   def _need_refreshing(token, refresh_offset=300):
       return not token or token.expires_on - time.time() < refresh_offset
   
   if __name__ == '__main__':
       re_authentication()
   

Go

Wird noch nicht unterstützt.

Node.js

1. Installieren Sie Abhängigkeiten.

   npm install redis @azure/identity
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter Azure Cache for Redis: Microsoft Entra ID mit der Clientbibliothek „node-redis“.

   import { createClient } from "redis";
   import { DefaultAzureCredential } from "@azure/identity";
   
   function extractUsernameFromToken(accessToken: AccessToken): string{
       const base64Metadata = accessToken.token.split(".")[1];
       const { oid } = JSON.parse(
           Buffer.from(base64Metadata, "base64").toString("utf8"),
       );
       return oid;
   }
   
   async function main() {
       // Uncomment the following lines corresponding to the authentication type you want to use.  
       // For system-assigned identity.
       // const credential = new DefaultAzureCredential();
   
       // For user-assigned identity.
       // const clientId = process.env.AZURE_REDIS_CLIENTID;
       // const credential = new DefaultAzureCredential({
       //     managedIdentityClientId: clientId
       // });
   
       // For service principal.
       // const tenantId = process.env.AZURE_REDIS_TENANTID;
       // const clientId = process.env.AZURE_REDIS_CLIENTID;
       // const clientSecret = process.env.AZURE_REDIS_CLIENTSECRET;
       // const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
   
       // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
       const redisScope = "https://redis.azure.com/.default";
       let accessToken = await credential.getToken(redisScope);
       console.log("access Token", accessToken);
       const host = process.env.AZURE_REDIS_HOST;
   
       // Create redis client and connect to Azure Cache for Redis over the TLS port using the access token as password.
       const client = createClient({
           username: extractUsernameFromToken(accessToken),
           password: accessToken.token,
           url: `redis://${host}:6380`,
           pingInterval: 100000,
           socket: { 
           tls: true,
           keepAlive: 0 
           },
       });
   
       client.on("error", (err) => console.log("Redis Client Error", err));
       await client.connect();
       // Set a value against your key in Azure Redis Cache.
       await client.set("Az:key", "value1312");
       // Get value of your key in Azure Redis Cache.
       console.log("value-", await client.get("Az:key"));
   }
   
   main().catch((err) => {
       console.log("error code: ", err.code);
       console.log("error message: ", err.message);
       console.log("error stack: ", err.stack);
   });
   

Andere

Für andere Sprachen können Sie die Azure-Identitätsclientbibliothek verwenden (und Verbindungsinformationen, die der Dienstconnector auf die Umgebungsvariablen festlegt), um eine Verbindung mit Azure Cache for Redis herzustellen.

Connection string

Warnung

Wir empfehlen Ihnen, den sichersten verfügbaren Authentifizierungsflow zu verwenden. Der hier beschriebene Authentifizierungsflow erfordert ein sehr hohes Maß an Vertrauen in die Anwendung und birgt Risiken, die in anderen Flows nicht vorhanden sind. Sie sollten diesen Flow nur verwenden, wenn sicherere Flows, z. B. verwaltete Identitäten, nicht praktikabel sind.

.NET

Standardname der Umgebungsvariablen	Beschreibung	Beispielswert
AZURE_REDIS_CONNECTIONSTRING	StackExchange.Redis-Verbindungszeichenfolge	<redis-server-name>.redis.cache.windows.net:6380,password=<redis-key>,ssl=True,defaultDatabase=0

Java

Standardname der Umgebungsvariablen	Beschreibung	Beispielswert
AZURE_REDIS_CONNECTIONSTRING	Jedis-Verbindungszeichenfolge	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

Spring Boot

Anwendungseigenschaften	Beschreibung	Beispielswert
spring.redis.host	Redis-Host	<redis-server-name>.redis.cache.windows.net
spring.redis.port	Redis-Port	6380
spring.redis.database	Redis-Datenbank	0
spring.redis.password	Redis-Schlüssel	<redis-key>
spring.redis.ssl	SSL-Einstellungen	true

Python

Standardname der Umgebungsvariablen	Beschreibung	Beispielswert
AZURE_REDIS_CONNECTIONSTRING	redis-py-Verbindungszeichenfolge	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

Go

Standardname der Umgebungsvariablen	Beschreibung	Beispielswert
AZURE_REDIS_CONNECTIONSTRING	redis-py-Verbindungszeichenfolge	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

Node.js

Standardname der Umgebungsvariablen	Beschreibung	Beispielswert
AZURE_REDIS_CONNECTIONSTRING	node-redis-Verbindungszeichenfolge	rediss://:<redis-key>@<redis-server-name>.redis.cache.windows.net:6380/0

Andere

Standardname der Umgebungsvariablen	Beschreibung	Beispielswert
AZURE_REDIS_HOST	Redis-Host	<redis-server-name>.redis.cache.windows.net
AZURE_REDIS_PORT	Redis-Port	6380
AZURE_REDIS_DATABASE	Redis-Datenbank	0
AZURE_REDIS_PASSWORD	Redis-Schlüssel	<redis-key>
AZURE_REDIS_SSL	SSL-Einstellungen	true

Beispielcode

Die folgenden Schritte und der folgende Code zeigen Ihnen, wie Sie eine Verbindungszeichenfolge verwenden, um eine Verbindung mit Azure Cache for Redis herzustellen.

.NET

1. Installieren Sie Abhängigkeiten.

   dotnet add package StackExchange.Redis --version 2.6.122
   

2. Rufen Sie die Verbindungszeichenfolge aus der Umgebungsvariablen ab, die vom Dienstconnector hinzugefügt wurde.

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

Java

1. Fügen Sie Ihrer Datei pom.xml die folgende Abhängigkeit hinzu:

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

2. Rufen Sie die Verbindungszeichenfolge aus der Umgebungsvariablen ab, die vom Dienstconnector hinzugefügt wurde.

   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);
   

Spring Boot

Weitere Informationen zur Einrichtung Ihrer Spring-Anwendung finden Sie unter Verwenden von Azure Redis Cache in Spring. Dienstconnector fügt die Konfigurationseigenschaften zu Spring-Apps hinzu.

Python

1. Installieren Sie Abhängigkeiten.

   pip install redis
   

2. Rufen Sie die Verbindungszeichenfolge aus der Umgebungsvariablen ab, die vom Dienstconnector hinzugefügt wurde.

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

Go

1. Installieren Sie Abhängigkeiten.

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

2. Rufen Sie die Verbindungszeichenfolge aus der Umgebungsvariablen ab, die vom Dienstconnector hinzugefügt wurde.

   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)
   

Node.js

1. Installieren Sie Abhängigkeiten.

   npm install redis
   

2. Rufen Sie die Verbindungszeichenfolge aus der Umgebungsvariablen ab, die vom Dienstconnector hinzugefügt wurde.

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

Andere

Für andere Sprachen können Sie die Verbindungsinformationen verwenden, die Service Connector auf die Umgebungsvariablen festlegt, um eine Verbindung mit Azure Cache for Redis herzustellen.

Dienstprinzipal

Standardname der Umgebungsvariablen	Beschreibung	Beispielwert
AZURE_REDIS_HOST	Redis-Endpunkt	<RedisName>.redis.cache.windows.net
AZURE_REDIS_CLIENTID	Client-ID des Dienstprinzipals	<client-ID>
AZURE_REDIS_CLIENTSECRET	Geheimnis des Dienstprinzipals	<client-secret>
AZURE_REDIS_TENANTID	Mandanten-ID des Dienstprinzipals	<tenant-id>

Beispielcode

Die folgenden Schritte und der folgende Code zeigen Ihnen, wie Sie einen Dienstprinzipal zum Herstellen einer Verbindung mit Redis verwenden.

.NET

1. Installieren Sie Abhängigkeiten.

   dotnet add package Microsoft.Azure.StackExchangeRedis --version 3.2.0
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter der Microsoft.Azure.StackExchangeRedis-Erweiterung.

   using StackExchange.Redis;
   var cacheHostName = Environment.GetEnvironmentVariable("AZURE_REDIS_HOST");
   var configurationOptions = ConfigurationOptions.Parse($"{cacheHostName}:6380");
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // await configurationOptions.ConfigureForAzureWithTokenCredentialAsync(new DefaultAzureCredential());
   
   // For user-assigned identity.
   // var managedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTID");
   // await configurationOptions.ConfigureForAzureWithUserAssignedManagedIdentityAsync(managedIdentityClientId);
   
   // Service principal secret.
   // var clientId = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTID");
   // var tenantId = Environment.GetEnvironmentVariable("AZURE_REDIS_TENANTID");
   // var secret = Environment.GetEnvironmentVariable("AZURE_REDIS_CLIENTSECRET");
   // await configurationOptions.ConfigureForAzureWithServicePrincipalAsync(clientId, tenantId, secret);
   
   
   var connectionMultiplexer = await ConnectionMultiplexer.ConnectAsync(configurationOptions);
   

Java

1. Fügen Sie Ihrer Datei pom.xml die folgende Abhängigkeit hinzu:

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.11.2</version> <!-- {x-version-update;com.azure:azure-identity;dependency} -->
   </dependency>
   
   <dependency>
       <groupId>redis.clients</groupId>
       <artifactId>jedis</artifactId>
       <version>5.1.0</version>  <!-- {x-version-update;redis.clients:jedis;external_dependency} -->
   </dependency>
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter Azure-AAD-Authentication-With-Jedis.

   import redis.clients.jedis.DefaultJedisClientConfig;
   import redis.clients.jedis.Jedis;
   import redis.clients.jedis.JedisShardInfo;
   import java.net.URI;
   
   // Uncomment the following lines corresponding to the authentication type you want to use.
   // For system-assigned identity.
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().build();
   
   // For user-assigned identity.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().managedIdentityClientId(clientId).build();
   
   // For AKS workload identity.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().workloadIdentityClientId(clientId).build();
   
   // For service principal.
   // String clientId = System.getenv("AZURE_REDIS_CLIENTID");
   // String secret = System.getenv("AZURE_REDIS_CLIENTSECRET");
   // String tenant = System.getenv("AZURE_REDIS_TENANTID");
   // ClientSecretCredential defaultAzureCredential = new ClientSecretCredentialBuilder().tenantId(tenant).clientId(clientId).clientSecret(secret).build();
   
   String token = defaultAzureCredential
   .getToken(new TokenRequestContext()
       .addScopes("https://redis.azure.com/.default")).block().getToken();
   
   // SSL connection is required.
   boolean useSsl = true;
   // TODO: Replace Host Name with Azure Cache for Redis Host Name.
   String username = extractUsernameFromToken(token);
   String cacheHostname = System.getenv("AZURE_REDIS_HOST");
   
   // Create Jedis client and connect to Azure Cache for Redis over the TLS/SSL port using the access token as password.
   // Note, Redis Cache host name and port are required below.
   Jedis jedis = new Jedis(cacheHostname, 6380, DefaultJedisClientConfig.builder()
       .password(token) // Microsoft Entra access token as password is required.
       .user(username) // Username is Required
       .ssl(useSsl) // SSL Connection is Required
       .build());
   
   // Set a value against your key in the Redis cache.
   jedis.set("Az:key", "testValue");
   System.out.println(jedis.get("Az:key"));
   
   // Close the Jedis Client
   jedis.close();
   

Spring Boot

Wird noch nicht unterstützt.

Python

1. Installieren Sie Abhängigkeiten.

   pip install redis azure-identity
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter azure-aad-auth-with-redis-py.

   import os
   import time
   import logging
   import redis
   import base64
   import json
   from azure.identity import DefaultAzureCredential
   
   host = os.getenv('AZURE_REDIS_HOST')
   scope = "https://redis.azure.com/.default"
   port = 6380  # Required
   
   def extract_username_from_token(token):
       parts = token.split('.')
       base64_str = parts[1]
   
       if len(base64_str) % 4 == 2:
           base64_str += "=="
       elif len(base64_str) % 4 == 3:
           base64_str += "="
   
       json_bytes = base64.b64decode(base64_str)
       json_str = json_bytes.decode('utf-8')
       jwt = json.loads(json_str)
   
       return jwt['oid']
   
   def re_authentication():
       _LOGGER = logging.getLogger(__name__)
       # Uncomment the following lines corresponding to the authentication type you want to use.
       # For system-assigned identity.
       # cred = DefaultAzureCredential()
   
       # For user-assigned identity.
       # client_id = os.getenv('AZURE_REDIS_CLIENTID')
       # cred = DefaultAzureCredential(managed_identity_client_id=client_id)
   
       # For user-assigned identity.
       # client_id = os.getenv('AZURE_REDIS_CLIENTID')
       # cred = DefaultAzureCredential(managed_identity_client_id=client_id)
   
       # For service principal.
       # tenant_id = os.getenv("AZURE_TENANT_ID")
       # client_id = os.getenv("AZURE_CLIENT_ID")
       # client_secret = os.getenv("AZURE_CLIENT_SECRET")
       # cred = ServicePrincipalCredentials(tenant=tenant_id, client_id=client_id, secret=client_secret)
   
       token = cred.get_token(scope)
       user_name = extract_username_from_token(token.token)
       r = redis.Redis(host=host,
                       port=port,
                       ssl=True,   # ssl connection is required.
                       username=user_name,
                       password=token.token,
                       decode_responses=True)
       max_retry = 3
       for index in range(max_retry):
           try:
               if _need_refreshing(token):
                   _LOGGER.info("Refreshing token...")
                   tmp_token = cred.get_token(scope)
                   if tmp_token:
                       token = tmp_token
                   r.execute_command("AUTH", user_name, token.token)
               r.set("Az:key1", "value1")
               t = r.get("Az:key1")
               print(t)
               break
           except redis.ConnectionError:
               _LOGGER.info("Connection lost. Reconnecting.")
               token = cred.get_token(scope)
               r = redis.Redis(host=host,
                               port=port,
                               ssl=True,   # ssl connection is required.
                               username=user_name,
                               password=token.token,
                               decode_responses=True)
           except Exception:
               _LOGGER.info("Unknown failures.")
               break
   
   
   def _need_refreshing(token, refresh_offset=300):
       return not token or token.expires_on - time.time() < refresh_offset
   
   if __name__ == '__main__':
       re_authentication()
   

Go

Wird noch nicht unterstützt.

Node.js

1. Installieren Sie Abhängigkeiten.

   npm install redis @azure/identity
   

2. Fügen Sie die Authentifizierungslogik mit vom Dienstconnector festgelegten Umgebungsvariablen hinzu. Weitere Informationen finden Sie unter Azure Cache for Redis: Microsoft Entra ID mit der Clientbibliothek „node-redis“.

   import { createClient } from "redis";
   import { DefaultAzureCredential } from "@azure/identity";
   
   function extractUsernameFromToken(accessToken: AccessToken): string{
       const base64Metadata = accessToken.token.split(".")[1];
       const { oid } = JSON.parse(
           Buffer.from(base64Metadata, "base64").toString("utf8"),
       );
       return oid;
   }
   
   async function main() {
       // Uncomment the following lines corresponding to the authentication type you want to use.  
       // For system-assigned identity.
       // const credential = new DefaultAzureCredential();
   
       // For user-assigned identity.
       // const clientId = process.env.AZURE_REDIS_CLIENTID;
       // const credential = new DefaultAzureCredential({
       //     managedIdentityClientId: clientId
       // });
   
       // For service principal.
       // const tenantId = process.env.AZURE_REDIS_TENANTID;
       // const clientId = process.env.AZURE_REDIS_CLIENTID;
       // const clientSecret = process.env.AZURE_REDIS_CLIENTSECRET;
       // const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
   
       // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
       const redisScope = "https://redis.azure.com/.default";
       let accessToken = await credential.getToken(redisScope);
       console.log("access Token", accessToken);
       const host = process.env.AZURE_REDIS_HOST;
   
       // Create redis client and connect to Azure Cache for Redis over the TLS port using the access token as password.
       const client = createClient({
           username: extractUsernameFromToken(accessToken),
           password: accessToken.token,
           url: `redis://${host}:6380`,
           pingInterval: 100000,
           socket: { 
           tls: true,
           keepAlive: 0 
           },
       });
   
       client.on("error", (err) => console.log("Redis Client Error", err));
       await client.connect();
       // Set a value against your key in Azure Redis Cache.
       await client.set("Az:key", "value1312");
       // Get value of your key in Azure Redis Cache.
       console.log("value-", await client.get("Az:key"));
   }
   
   main().catch((err) => {
       console.log("error code: ", err.code);
       console.log("error message: ", err.message);
       console.log("error stack: ", err.stack);
   });
   

Andere

Für andere Sprachen können Sie die Azure-Identitätsclientbibliothek verwenden (und Verbindungsinformationen, die der Dienstconnector auf die Umgebungsvariablen festlegt), um eine Verbindung mit Azure Cache for Redis herzustellen.

Zugehöriger Inhalt

• Informationen zu Service Connector-Konzepten