Tweaks

Author: RussKie

playground/AzureStorageEndToEnd/AzureStorageEndToEnd.ApiService/Program.cs

@@ -12,27 +12,29 @@
 builder.AddKeyedAzureBlobContainerClient("foocontainer");
 
 builder.AddAzureQueueClient("queues");
+builder.AddKeyedAzureQueueClient("myqueue");
 
 var app = builder.Build();
 
 app.MapDefaultEndpoints();
 
-app.MapGet("/", async (BlobServiceClient bsc, QueueServiceClient qsc, [FromKeyedServices("foocontainer")] BlobContainerClient keyedContainerClient1) =>
+app.MapGet("/", async (BlobServiceClient bsc, QueueServiceClient qsc, [FromKeyedServices("foocontainer")] BlobContainerClient bcc, [FromKeyedServices("myqueue")] QueueClient qc) =>
 {
     var blobNames = new List<string>();
     var blobNameAndContent = Guid.NewGuid().ToString();
 
-    await keyedContainerClient1.UploadBlobAsync(blobNameAndContent, new BinaryData(blobNameAndContent));
+    await bcc.UploadBlobAsync(blobNameAndContent, new BinaryData(blobNameAndContent));
 
     var directContainerClient = bsc.GetBlobContainerClient(blobContainerName: "test-container-1");
     await directContainerClient.UploadBlobAsync(blobNameAndContent, new BinaryData(blobNameAndContent));
 
     await ReadBlobsAsync(directContainerClient, blobNames);
-    await ReadBlobsAsync(keyedContainerClient1, blobNames);
+    await ReadBlobsAsync(bcc, blobNames);
 
+    // This will check the queue exists.
     var queue = qsc.GetQueueClient("myqueue");
-    await queue.CreateIfNotExistsAsync();
-    await queue.SendMessageAsync("Hello, world!");
+
+    await qc.SendMessageAsync("Hello, world!");
 
     return blobNames;
 });

playground/AzureStorageEndToEnd/AzureStorageEndToEnd.AppHost/Program.cs

@@ -13,6 +13,7 @@
 blobs.AddBlobContainer("mycontainer2", blobContainerName: "test-container-2");
 
 var queues = storage.AddQueues("queues");
+var myqueue = queues.AddQueue("myqueue", queueName: "my-queue");
 
 var storage2 = builder.AddAzureStorage("storage2").RunAsEmulator(container =>
 {
@@ -25,7 +26,8 @@
        .WithExternalHttpEndpoints()
        .WithReference(blobs).WaitFor(blobs)
        .WithReference(blobContainer2).WaitFor(blobContainer2)
-       .WithReference(queues).WaitFor(queues);
+       .WithReference(queues).WaitFor(queues)
+       .WithReference(myqueue).WaitFor(myqueue);
 
 #if !SKIP_DASHBOARD_REFERENCE
 // This project is only added in playground projects to support development/debugging

src/Aspire.Hosting.Azure.Storage/AzureQueueStorageResource.cs

@@ -16,7 +16,7 @@ public class AzureQueueStorageResource(string name, AzureStorageResource storage
     IResourceWithParent<AzureStorageResource>,
     IResourceWithAzureFunctionsConfig
 {
-    // NOTE: if ever these contants are changed, the AzureBlobStorageContainerSettings in Aspire.Azure.Storage.Blobs class should be updated as well.
+    // NOTE: if ever these contants are changed, the AzureStorageQueueSettings in Aspire.Azure.Storage.Queues class should be updated as well.
     private const string Endpoint = nameof(Endpoint);
     private const string QueueName = nameof(QueueName);
 
@@ -69,10 +69,10 @@ void IResourceWithAzureFunctionsConfig.ApplyAzureFunctionsConfiguration(IDiction
     /// <summary>
     /// Converts the current instance to a provisioning entity.
     /// </summary>
-    /// <returns>A <see cref="global::Azure.Provisioning.Storage.BlobService"/> instance.</returns>
-    internal global::Azure.Provisioning.Storage.BlobService ToProvisioningEntity()
+    /// <returns>A <see cref="global::Azure.Provisioning.Storage.QueueService"/> instance.</returns>
+    internal global::Azure.Provisioning.Storage.QueueService ToProvisioningEntity()
     {
-        global::Azure.Provisioning.Storage.BlobService service = new(Infrastructure.NormalizeBicepIdentifier(Name));
+        global::Azure.Provisioning.Storage.QueueService service = new(Infrastructure.NormalizeBicepIdentifier(Name));
         return service;
     }
 }

src/Components/Aspire.Azure.Storage.Queues/AspireQueueStorageExtensions.StorageQueueComponent.cs

@@ -24,7 +24,7 @@ protected override IAzureClientBuilder<QueueClient, QueueClientOptions> AddClien
             {
                 if (string.IsNullOrEmpty(settings.QueueName))
                 {
-                    throw new InvalidOperationException($"The connection string '{connectionName}' does not exist or is missing the container name.");
+                    throw new InvalidOperationException($"The connection string '{connectionName}' does not exist or is missing the queue name.");
                 }
 
                 var connectionString = settings.ConnectionString;

src/Components/Aspire.Azure.Storage.Queues/AspireQueueStorageExtensions.cs

@@ -91,7 +91,7 @@ public static void AddKeyedAzureQueueClient(
     /// <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>
+    /// <remarks>Reads the configuration from "Aspire:Azure:Storage:Queues:{name}" section.</remarks>
     /// <exception cref="InvalidOperationException">
     ///  Neither <see cref="AzureStorageQueuesSettings.ConnectionString"/> nor <see cref="AzureStorageQueuesSettings.ServiceUri"/> is provided.
     ///  - or -
@@ -125,7 +125,7 @@ public static void AddAzureQueue(
     /// <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>
+    /// <remarks>Reads the configuration from "Aspire:Azure:Storage:Queues:{name}" section.</remarks>
     /// <exception cref="InvalidOperationException">
     ///  Neither <see cref="AzureStorageQueuesSettings.ConnectionString"/> nor <see cref="AzureStorageQueuesSettings.ServiceUri"/> is provided.
     ///  - or -

tests/Aspire.Hosting.Azure.Tests/Snapshots/AzureStorageExtensionsTests.ResourceNamesBicepValid.verified.bicep

@@ -26,6 +26,10 @@ resource blobs 'Microsoft.Storage/storageAccounts/blobServices@2024-01-01' = {
   parent: storage
 }
 
+resource queues 'Microsoft.Storage/storageAccounts/queueServices@2024-01-01' = {
+  parent: storage
+}
+
 resource myContainer 'Microsoft.Storage/storageAccounts/blobServices/containers@2024-01-01' = {
   name: 'my-blob-container'
   parent: blobs