AddKeyedAzureBlobContainerClient

Author: RussKie

playground/AzureStorageEndToEnd/AzureStorageEndToEnd.ApiService/Program.cs

@@ -9,18 +9,46 @@
 builder.AddServiceDefaults();
 
 builder.AddAzureBlobClient("blobs");
-builder.AddAzureBlobContainerClient("foocontainer");
+//builder.AddAzureBlobContainerClient("foocontainer");
+builder.AddKeyedAzureBlobContainerClient("mycontainer2");
+builder.AddKeyedAzureBlobContainerClient("foocontainer");
 
 builder.AddAzureQueueClient("queues");
 
 var app = builder.Build();
 
 app.MapDefaultEndpoints();
-app.MapGet("/", async (BlobServiceClient bsc, QueueServiceClient qsc, BlobContainerClient bcc) =>
+
+app.MapGet("/", async ([FromKeyedServices("mycontainer2")] BlobContainerClient keyedContainerClinet1,
+                       [FromKeyedServices("foocontainer")] BlobContainerClient keyedContainerClinet2) =>
 {
-    var container = bsc.GetBlobContainerClient(blobContainerName: "test-container-1");
+    var blobNames = new List<string>();
+    var blobNameAndContent = Guid.NewGuid().ToString();
+
+    await keyedContainerClinet1.UploadBlobAsync(blobNameAndContent, new BinaryData(blobNameAndContent));
+    await keyedContainerClinet2.UploadBlobAsync(blobNameAndContent, new BinaryData(blobNameAndContent));
+
+    var blobs = keyedContainerClinet1.GetBlobsAsync();
+    blobNames.Add(keyedContainerClinet1.Uri.ToString());
+    await foreach (var blob in blobs)
+    {
+        blobNames.Add(blob.Name);
+    }
 
+    blobs = keyedContainerClinet2.GetBlobsAsync();
+    blobNames.Add(keyedContainerClinet2.Uri.ToString());
+    await foreach (var blob in blobs)
+    {
+        blobNames.Add(blob.Name);
+    }
+
+    return blobNames;
+});
+app.MapGet("/test", async (BlobServiceClient bsc, QueueServiceClient qsc, BlobContainerClient fooContainerClinet) =>
+{
     var blobNameAndContent = Guid.NewGuid().ToString();
+
+    var container = bsc.GetBlobContainerClient(blobContainerName: "test-container-1");
     await container.UploadBlobAsync(blobNameAndContent, new BinaryData(blobNameAndContent));
 
     var blobs = container.GetBlobsAsync();

playground/AzureStorageEndToEnd/AzureStorageEndToEnd.AppHost/Program.cs

@@ -10,7 +10,7 @@
 
 var blobs = storage.AddBlobs("blobs");
 blobs.AddBlobContainer("mycontainer1", blobContainerName: "test-container-1");
-blobs.AddBlobContainer("mycontainer2", blobContainerName: "test-container-2");
+var blobContainer1 = blobs.AddBlobContainer("mycontainer2", blobContainerName: "test-container-2");
 
 var queues = storage.AddQueues("queues");
 
@@ -24,6 +24,7 @@
 builder.AddProject<Projects.AzureStorageEndToEnd_ApiService>("api")
        .WithExternalHttpEndpoints()
        .WithReference(blobs).WaitFor(blobs)
+       .WithReference(blobContainer1).WaitFor(blobContainer1)
        .WithReference(blobContainer2).WaitFor(blobContainer2)
        .WithReference(queues).WaitFor(queues);
 

src/Components/Aspire.Azure.Storage.Blobs/AspireBlobStorageExtensions.cs

@@ -16,15 +16,23 @@ public static partial class AspireBlobStorageExtensions
     private const string DefaultConfigSectionName = "Aspire:Azure:Storage:Blobs";
 
     /// <summary>
-    /// Registers <see cref="BlobServiceClient"/> as a singleton in the services provided by the <paramref name="builder"/>.
-    /// Enables retries, corresponding health check, logging and telemetry.
+    ///  Registers <see cref="BlobServiceClient"/> as a singleton in the services provided by the <paramref name="builder"/>.
+    ///  Enables retries, corresponding health check, logging and telemetry.
     /// </summary>
     /// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param>
-    /// <param name="connectionName">A name used to retrieve the connection string from the ConnectionStrings configuration section.</param>
-    /// <param name="configureSettings">An optional method that can be used for customizing the <see cref="AzureStorageBlobsSettings"/>. It's invoked after the settings are read from the configuration.</param>
-    /// <param name="configureClientBuilder">An optional method that can be used for customizing the <see cref="IAzureClientBuilder{TClient, TOptions}"/>.</param>
+    /// <param name="connectionName">
+    ///  A name used to retrieve the connection string from the ConnectionStrings configuration section.
+    /// </param>
+    /// <param name="configureSettings">
+    ///  An optional method that can be used for customizing the <see cref="AzureStorageBlobsSettings"/>. It's invoked after the settings are read from the configuration.
+    /// </param>
+    /// <param name="configureClientBuilder">
+    ///  An optional method that can be used for customizing the <see cref="IAzureClientBuilder{TClient, TOptions}"/>.
+    /// </param>
     /// <remarks>Reads the configuration from "Aspire:Azure:Storage:Blobs" section.</remarks>
-    /// <exception cref="InvalidOperationException">Thrown when neither <see cref="AzureStorageBlobsSettings.ConnectionString"/> nor <see cref="AzureStorageBlobsSettings.ServiceUri"/> is provided.</exception>
+    /// <exception cref="InvalidOperationException">
+    ///  Neither <see cref="AzureStorageBlobsSettings.ConnectionString"/> nor <see cref="AzureStorageBlobsSettings.ServiceUri"/> is provided.
+    /// </exception>
     public static void AddAzureBlobClient(
         this IHostApplicationBuilder builder,
         string connectionName,
@@ -38,15 +46,25 @@ public static void AddAzureBlobClient(
     }
 
     /// <summary>
-    /// Registers <see cref="BlobServiceClient"/> as a singleton for given <paramref name="name"/> in the services provided by the <paramref name="builder"/>.
-    /// Enables retries, corresponding health check, logging and telemetry.
+    ///  Registers <see cref="BlobServiceClient"/> as a singleton for given <paramref name="name"/> in the services provided by the <paramref name="builder"/>.
+    ///  Enables retries, corresponding health check, logging and telemetry.
     /// </summary>
     /// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param>
-    /// <param name="name">The name of the component, which is used as the <see cref="ServiceDescriptor.ServiceKey"/> of the service and also to retrieve the connection string from the ConnectionStrings configuration section.</param>
-    /// <param name="configureSettings">An optional method that can be used for customizing the <see cref="AzureStorageBlobsSettings"/>. It's invoked after the settings are read from the configuration.</param>
-    /// <param name="configureClientBuilder">An optional method that can be used for customizing the <see cref="IAzureClientBuilder{TClient, TOptions}"/>.</param>
+    /// <param name="name">
+    ///  The name of the component, which is used as the <see cref="ServiceDescriptor.ServiceKey"/> of the service and also to retrieve
+    ///  the connection string from the ConnectionStrings configuration section.
+    /// </param>
+    /// <param name="configureSettings">
+    ///  An optional method that can be used for customizing the <see cref="AzureStorageBlobsSettings"/>.
+    ///  It's invoked after the settings are read from the configuration.
+    /// </param>
+    /// <param name="configureClientBuilder">
+    ///  An optional method that can be used for customizing the <see cref="IAzureClientBuilder{TClient, TOptions}"/>.
+    /// </param>
     /// <remarks>Reads the configuration from "Aspire:Azure:Storage:Blobs:{name}" section.</remarks>
-    /// <exception cref="InvalidOperationException">Thrown when neither <see cref="AzureStorageBlobsSettings.ConnectionString"/> nor <see cref="AzureStorageBlobsSettings.ServiceUri"/> is provided.</exception>
+    /// <exception cref="InvalidOperationException">
+    ///  Neither <see cref="AzureStorageBlobsSettings.ConnectionString"/> nor <see cref="AzureStorageBlobsSettings.ServiceUri"/> is provided.
+    /// </exception>
     public static void AddKeyedAzureBlobClient(
         this IHostApplicationBuilder builder,
         string name,
@@ -60,13 +78,18 @@ public static void AddKeyedAzureBlobClient(
     }
 
     /// <summary>
-    /// Registers <see cref="BlobContainerClient"/> as a singleton in the services provided by the <paramref name="builder"/>.
-    /// Enables retries, corresponding health check, logging and telemetry.
+    ///  Registers <see cref="BlobContainerClient"/> as a singleton in the services provided by the <paramref name="builder"/>.
+    ///  Enables retries, corresponding health check, logging and telemetry.
     /// </summary>
     /// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param>
     /// <param name="connectionName">A name used to retrieve the connection string from the ConnectionStrings configuration section.</param>
-    /// <param name="configureSettings">An optional method that can be used for customizing the <see cref="AzureStorageBlobsSettings"/>. It's invoked after the settings are read from the configuration.</param>
-    /// <param name="configureClientBuilder">An optional method that can be used for customizing the <see cref="IAzureClientBuilder{TClient, TOptions}"/>.</param>
+    /// <param name="configureSettings">
+    ///  An optional method that can be used for customizing the <see cref="AzureStorageBlobsSettings"/>.
+    ///  It's invoked after the settings are read from the configuration.
+    /// </param>
+    /// <param name="configureClientBuilder">
+    ///  An optional method that can be used for customizing the <see cref="IAzureClientBuilder{TClient, TOptions}"/>.
+    /// </param>
     /// <remarks>Reads the configuration from "Aspire:Azure:Storage:Blobs" section.</remarks>
     /// <exception cref="InvalidOperationException">
     ///  Neither <see cref="AzureStorageBlobsSettings.ConnectionString"/> nor <see cref="AzureStorageBlobsSettings.ServiceUri"/> is provided.
@@ -84,4 +107,38 @@ public static void AddAzureBlobContainerClient(
 
         new BlobStorageContainerComponent().AddClient(builder, DefaultConfigSectionName, configureSettings, configureClientBuilder, connectionName, serviceKey: null);
     }
+
+    /// <summary>
+    ///  Registers <see cref="BlobContainerClient"/> as a singleton in the services provided by the <paramref name="builder"/>.
+    ///  Enables retries, corresponding health check, logging and telemetry.
+    /// </summary>
+    /// <param name="builder">The <see cref="IHostApplicationBuilder" /> to read config from and add services to.</param>
+    /// <param name="name">
+    ///  The name of the component, which is used as the <see cref="ServiceDescriptor.ServiceKey"/> of the service and also to retrieve
+    ///  the connection string from the ConnectionStrings configuration section.
+    /// </param>
+    /// <param name="configureSettings">
+    ///  An optional method that can be used for customizing the <see cref="AzureStorageBlobsSettings"/>.
+    ///  It's invoked after the settings are read from the configuration.
+    /// </param>
+    /// <param name="configureClientBuilder">
+    ///  An optional method that can be used for customizing the <see cref="IAzureClientBuilder{TClient, TOptions}"/>.
+    /// </param>
+    /// <remarks>Reads the configuration from "Aspire:Azure:Storage:Blobs:{name}" section.</remarks>
+    /// <exception cref="InvalidOperationException">
+    ///  Neither <see cref="AzureStorageBlobsSettings.ConnectionString"/> nor <see cref="AzureStorageBlobsSettings.ServiceUri"/> is provided.
+    ///  - or -
+    ///  <see cref="AzureBlobStorageContainerSettings.BlobContainerName"/> is not provided in the configuration section.
+    /// </exception>
+    public static void AddKeyedAzureBlobContainerClient(
+        this IHostApplicationBuilder builder,
+        string name,
+        Action<AzureBlobStorageContainerSettings>? configureSettings = null,
+        Action<IAzureClientBuilder<BlobContainerClient, BlobClientOptions>>? configureClientBuilder = null)
+    {
+        ArgumentNullException.ThrowIfNull(builder);
+        ArgumentException.ThrowIfNullOrEmpty(name);
+
+        new BlobStorageContainerComponent().AddClient(builder, DefaultConfigSectionName, configureSettings, configureClientBuilder, connectionName: name, serviceKey: name);
+    }
 }

src/Components/Aspire.Azure.Storage.Blobs/AzureBlobStorageContainerSettings.cs

@@ -44,7 +44,7 @@ void IConnectionStringSettings.ParseConnectionString(string? connectionString)
             }
 
             // We can't use connectionBuilder.ConnectionString here, because connectionBuilder escapes values
-            // adding quotes and other characters, which upset the Azure SDK.
+            // adding quotes and other characters, which upsets the Azure SDK.
             // So, we have rebuilt the connection string manually.
 
             StringBuilder builder = new();