AzureManagedRedisExtensions Methods
Class Methods 4 members
Provides extension methods for adding the Azure Managed Redis resources to the application model.
AddAzureManagedRedis(IDistributedApplicationBuilder, string) Section titled AddAzureManagedRedis(IDistributedApplicationBuilder, string) extension IResourceBuilder<AzureManagedRedisResource> Adds an Azure Managed Redis resource to the application model.
public static class AzureManagedRedisExtensions{ public static IResourceBuilder<AzureManagedRedisResource> AddAzureManagedRedis( this IDistributedApplicationBuilder builder, string name) { // ... }}Parameters
builder IDistributedApplicationBuilder The builder for the distributed application. name string The name of the resource. Returns
IResourceBuilder<AzureManagedRedisResource> A reference to the ApplicationModel.IResourceBuilder`1 builder. Remarks
By default, the Azure Managed Redis resource is configured to use Microsoft Entra ID (Azure Active Directory) for authentication. This requires changes to the application code to use an azure credential to authenticate with the resource. See https://github.com/Azure/Microsoft.Azure.StackExchangeRedis for more information. The following example creates an Azure Managed Redis resource and referencing that resource in a .NET project.
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddAzureManagedRedis("cache");
builder.AddProject<Projects.ProductService>() .WithReference(cache);
builder.Build().Run();RunAsContainer(IResourceBuilder<AzureManagedRedisResource>, Action<IResourceBuilder<RedisResource>>) Section titled RunAsContainer(IResourceBuilder<AzureManagedRedisResource>, Action<IResourceBuilder<RedisResource>>) extension IResourceBuilder<AzureManagedRedisResource> Configures an Azure Managed Redis resource to run locally in a container.
public static class AzureManagedRedisExtensions{ public static IResourceBuilder<AzureManagedRedisResource> RunAsContainer( this IResourceBuilder<AzureManagedRedisResource> builder, Action<IResourceBuilder<RedisResource>>? configureContainer = null) { // ... }}Parameters
builder IResourceBuilder<AzureManagedRedisResource> The Azure Managed Redis resource builder. configureContainer Action<IResourceBuilder<RedisResource>> optional Callback that exposes underlying container to allow for customization. Returns
IResourceBuilder<AzureManagedRedisResource> A reference to the ApplicationModel.IResourceBuilder`1 builder. Remarks
The following example creates an Azure Managed Redis resource that runs locally in a Redis container and referencing that resource in a .NET project.
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddAzureManagedRedis("cache") .RunAsContainer();
builder.AddProject<Projects.ProductService>() .WithReference(cache);
builder.Build().Run();WithAccessKeyAuthentication(IResourceBuilder<AzureManagedRedisResource>) Section titled WithAccessKeyAuthentication(IResourceBuilder<AzureManagedRedisResource>) extension IResourceBuilder<AzureManagedRedisResource> Configures the resource to use access key authentication for Azure Managed Redis.
public static class AzureManagedRedisExtensions{ public static IResourceBuilder<AzureManagedRedisResource> WithAccessKeyAuthentication( this IResourceBuilder<AzureManagedRedisResource> builder) { // ... }}Parameters
builder IResourceBuilder<AzureManagedRedisResource> The Azure Managed Redis resource builder. Returns
IResourceBuilder<AzureManagedRedisResource> A reference to the ApplicationModel.IResourceBuilder`1 builder. Remarks
The following example creates an Azure Managed Redis resource that uses access key authentication.
var builder = DistributedApplication.CreateBuilder(args);
var cache = builder.AddAzureManagedRedis("cache") .WithAccessKeyAuthentication();
builder.AddProject<Projects.ProductService>() .WithReference(cache);
builder.Build().Run();WithAccessKeyAuthentication(IResourceBuilder<AzureManagedRedisResource>, IResourceBuilder<IAzureKeyVaultResource>) Section titled WithAccessKeyAuthentication(IResourceBuilder<AzureManagedRedisResource>, IResourceBuilder<IAzureKeyVaultResource>) extension IResourceBuilder<AzureManagedRedisResource> Configures the resource to use access key authentication for Azure Managed Redis.
public static class AzureManagedRedisExtensions{ public static IResourceBuilder<AzureManagedRedisResource> WithAccessKeyAuthentication( this IResourceBuilder<AzureManagedRedisResource> builder, IResourceBuilder<IAzureKeyVaultResource> keyVaultBuilder) { // ... }}Parameters
builder IResourceBuilder<AzureManagedRedisResource> The Azure Managed Redis resource builder. keyVaultBuilder IResourceBuilder<IAzureKeyVaultResource> The Azure Key Vault resource builder where the connection string used to connect to this AzureManagedRedisResource will be stored. Returns
IResourceBuilder<AzureManagedRedisResource> A reference to the ApplicationModel.IResourceBuilder`1 builder.