|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
#pragma warning disable AZPROVISION001
using System.Diagnostics.CodeAnalysis;
using Aspire.Hosting.ApplicationModel;
using Aspire.Hosting.Azure;
using RedisResource = Aspire.Hosting.ApplicationModel.RedisResource;
using CdkRedisResource = Azure.Provisioning.Redis.RedisResource;
using Azure.Provisioning.Redis;
using Azure.Provisioning.KeyVault;
using Azure.Provisioning;
using Azure.Provisioning.Expressions;
namespace Aspire.Hosting;
/// <summary>
/// Provides extension methods for adding the Azure Redis resources to the application model.
/// </summary>
public static class AzureRedisExtensions
{
/// <summary>
/// Configures the resource to be published as Azure Cache for Redis when deployed via Azure Developer CLI.
/// </summary>
/// <param name="builder">The <see cref="IResourceBuilder{RedisResource}"/> builder.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{RedisResource}"/> builder.</returns>
public static IResourceBuilder<RedisResource> PublishAsAzureRedis(this IResourceBuilder<RedisResource> builder)
{
return builder.PublishAsAzureRedis(null);
}
/// <summary>
/// Configures the resource to be published as Azure Cache for Redis when deployed via Azure Developer CLI.
/// </summary>
/// <param name="builder">The <see cref="IResourceBuilder{RedisResource}"/> builder.</param>
/// <param name="configureResource">Callback to configure the underlying <see cref="global::Azure.Provisioning.Redis.RedisResource"/> resource.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{RedisResource}"/> builder.</returns>
[Experimental("AZPROVISION001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
public static IResourceBuilder<RedisResource> PublishAsAzureRedis(this IResourceBuilder<RedisResource> builder, Action<IResourceBuilder<AzureRedisResource>, ResourceModuleConstruct, CdkRedisResource>? configureResource)
{
return builder.PublishAsAzureRedisInternal(configureResource);
}
internal static IResourceBuilder<RedisResource> PublishAsAzureRedisInternal(this IResourceBuilder<RedisResource> builder, Action<IResourceBuilder<AzureRedisResource>, ResourceModuleConstruct, CdkRedisResource>? configureResource, bool useProvisioner = false)
{
builder.ApplicationBuilder.AddAzureProvisioning();
var configureConstruct = (ResourceModuleConstruct construct) =>
{
var kvNameParam = new BicepParameter("keyVaultName", typeof(string));
construct.Add(kvNameParam);
var keyVault = KeyVaultService.FromExisting("keyVault");
keyVault.Name = kvNameParam;
construct.Add(keyVault);
var redisCache = new CdkRedisResource(builder.Resource.Name, "2020-06-01") // TODO: resource version should come from CDK
{
Sku = new RedisSku()
{
Name = RedisSkuName.Basic,
Family = RedisSkuFamily.BasicOrStandard,
Capacity = 1
},
EnableNonSslPort = false,
MinimumTlsVersion = RedisTlsVersion.Tls1_2,
Tags = { { "aspire-resource-name", construct.Resource.Name } }
};
construct.Add(redisCache);
var secret = new KeyVaultSecret("connectionString")
{
Parent = keyVault,
Name = "connectionString",
Properties = new SecretProperties
{
Value = BicepFunction.Interpolate($"{redisCache.HostName},ssl=true,password={redisCache.GetKeys().PrimaryKey}")
}
};
construct.Add(secret);
var resource = (AzureRedisResource)construct.Resource;
var resourceBuilder = builder.ApplicationBuilder.CreateResourceBuilder(resource);
configureResource?.Invoke(resourceBuilder, construct, redisCache);
};
var resource = new AzureRedisResource(builder.Resource, configureConstruct);
var resourceBuilder = builder.ApplicationBuilder.CreateResourceBuilder(resource)
.WithParameter(AzureBicepResource.KnownParameters.KeyVaultName)
.WithManifestPublishingCallback(resource.WriteToManifest);
if (useProvisioner)
{
// Used to hold a reference to the azure surrogate for use with the provisioner.
builder.WithAnnotation(new AzureBicepResourceAnnotation(resource));
builder.WithConnectionStringRedirection(resource);
// Remove the container annotation so that DCP doesn't do anything with it.
if (builder.Resource.Annotations.OfType<ContainerImageAnnotation>().SingleOrDefault() is { } containerAnnotation)
{
builder.Resource.Annotations.Remove(containerAnnotation);
}
}
return builder;
}
/// <summary>
/// Configures resource to use Azure for local development and when doing a deployment via the Azure Developer CLI.
/// </summary>
/// <param name="builder">The <see cref="IResourceBuilder{RedisResource}"/> builder.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{RedisResource}"/> builder.</returns>
public static IResourceBuilder<RedisResource> AsAzureRedis(this IResourceBuilder<RedisResource> builder)
{
return builder.AsAzureRedis(null);
}
/// <summary>
/// Configures resource to use Azure for local development and when doing a deployment via the Azure Developer CLI.
/// </summary>
/// <param name="builder">The <see cref="IResourceBuilder{RedisResource}"/> builder.</param>
/// <param name="configureResource">Callback to configure the underlying <see cref="global::Azure.Provisioning.Redis.RedisResource"/> resource.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{RedisResource}"/> builder.</returns>
[Experimental("AZPROVISION001", UrlFormat = "https://aka.ms/dotnet/aspire/diagnostics#{0}")]
public static IResourceBuilder<RedisResource> AsAzureRedis(this IResourceBuilder<RedisResource> builder, Action<IResourceBuilder<AzureRedisResource>, ResourceModuleConstruct, CdkRedisResource>? configureResource)
{
return builder.PublishAsAzureRedisInternal(configureResource, useProvisioner: true);
}
}
|