AspireMicrosoftAzureStackExchangeRedisExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Microsoft.Azure.StackExchangeRedis / AspireMicrosoftAzureStackExchangeRedisExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Microsoft.Azure.StackExchangeRedis AspireMicrosoftAzureStackExchangeRedisExtensions Methods

Class Methods 1 member

Extension methods for connecting to an Azure Cache for Redis with StackExchange.Redis client using Azure AD authentication.

WithAzureAuthentication(AspireRedisClientBuilder, TokenCredential?) extension AspireRedisClientBuilder

Configures the Redis client to use Azure AD authentication for connecting to Azure Cache for Redis.

public static class AspireMicrosoftAzureStackExchangeRedisExtensions
{
    public static AspireRedisClientBuilder WithAzureAuthentication(
        this AspireRedisClientBuilder builder,
        TokenCredential? credential = null)
    {
        // ...
    }
}

AspireMicrosoftAzureStackExchangeRedisExtensions.cs#L30-L50

Parameters

builder AspireRedisClientBuilder The Redis.AspireRedisClientBuilder to configure.

credential TokenCredential? optional The Core.TokenCredential to use for Azure AD authentication. If null, Identity.DefaultAzureCredential will be used.

Returns

AspireRedisClientBuilder The Redis.AspireRedisClientBuilder for method chaining.

Remarks

This extension method configures the Redis client to authenticate with Azure Cache for Redis using Azure AD (Entra ID) instead of access keys. It leverages the Microsoft.Azure.StackExchangeRedis library to handle the Azure AD authentication flow.