Step-by-step guide on how to use the .Net Aspire Azure Queue Storage component in Visual Studio. Introduction .Net Aspire framework is used to develop cloud and production-ready distributed applications. It consists of components to handle cloud-native concerns such as Redis, Postgres etc. Prerequisites Install .Net 8
Install Visual Studio 2022 version 17 or higher
.Net Aspire Workload
Container runtime such as Docker Desktop Objectives Learn how to create a starter project using .Net Aspire with the Azure Queue Storage. Github Sample: The solution structure is divided into the following projects DotnetAspireChallenge.ApiService
DotnetAspireChallenge.AppHost
DotnetAspireChallenge.ServiceDefaults
DotnetAspireChallenge.Web Getting Started Step 1: Install the following NuGet package Install the following Nuget package into the subsequent project “DotnetAspireChallenge.AppHost” dotnet add package Aspire.Hosting.Azure.Storage In the above project, register the Azure storage, queue and emulator. var storage = builder.AddAzureStorage("storage");
    var queues = storage.AddQueues("queues"); **Note: ** The particular tag is used to skip version checks. Step 2: Install another NuGet package Install the following Nuget package into the subsequent project “DotnetAspireChallenge.ApiService” dotnet add package Aspire.Azure.Storage.Queues then register the context into the Program.cs file as follows builder.AddAzureQueueClient("queues"); Step 3: Create an extension class Create an extension class and register a minimal API send and receive method to demonstrate the QueueServiceClient usage in the API Service public static class AspireAzureQueueExtension
    {
        public static void MapAzureQueueEndpoint(this WebApplication app)
        {
            app.MapGet("/queue-send", async (QueueServiceClient queueServiceClient) =>
            {
                try
                {
                    var queueClient = queueServiceClient.GetQueueClient("test");
                    await queueClient.CreateIfNotExistsAsync();
    
                    if (await queueClient.ExistsAsync())
                    {
                        await queueClient.SendMessageAsync("Test Message ");
                        return Results.Ok($"Message sent to queue: test");
                    }
                    return Results.NotFound($"Queue not found: test");
                }
                catch (RequestFailedException e)
                {
                    Console.WriteLine("HTTP error code {0}: {1}", e.Status, e.ErrorCode);
                    Console.WriteLine(e.Message);
                    return Results.Problem($"HTTP error code {e.Status}: {e.Message}");
                }
            });
    
    
            app.MapGet("/queue-recieve", async (QueueServiceClient queueServiceClient) =>
            {
                try
                {
                    var queueClient = queueServiceClient.GetQueueClient("test");
                    if (await queueClient.ExistsAsync())
                    {
                        var response = await queueClient.ReceiveMessageAsync();
                        if (response?.Value != null)
                        {
                            var message = response.Value;
                            // Delete the message after processing
                            await queueClient.DeleteMessageAsync(message.MessageId, message.PopReceipt);
                            return Results.Ok($"Received message: {message.MessageText}");
                        }
                        return Results.Ok("No messages in the queue.");
                    }
                    return Results.NotFound($"Queue not found: test");
                }
                catch (RequestFailedException e)
                {
                    Console.WriteLine("HTTP error code {0}: {1}", e.Status, e.ErrorCode);
                    Console.WriteLine(e.Message);
                    return Results.Problem($"HTTP error code {e.Status}: {e.Message}");
                }
            });
        }
    } and finally, register in the Program.cs file app.MapAzureQueueEndpoint(); Add additional connection string properties using the JSON syntax {
      "Aspire": {
        "Azure": {
          "Storage": {
            "Queues": {
              "DisableHealthChecks": true,
              "DisableTracing": false,
              "ClientOptions": {
                "Diagnostics": {
                  "ApplicationId": "myapp"
                }
              }
            }
          }
        }
      }
    } Congratulations..!! You’ve successfully integrated the Azure Queue Storage component into the .Net Aspire project. Github Project GitHub - ssukhpinder/DotnetAspireChallenge: 10 Day .Net Aspire Challenge More Cheatsheets Cheat Sheets — .Net C# Programming🚀 Thank you for being a part of the C# community! Before you leave: Follow us: Youtube | X | LinkedIn | Dev.to
Visit our other platforms: GitHub
More content at C# Programming Step-by-step guide on how to use the .Net Aspire Azure Queue Storage component in Visual Studio. Introduction .Net Aspire framework is used to develop cloud and production-ready distributed applications. It consists of components to handle cloud-native concerns such as Redis, Postgres etc. Prerequisites Install .Net 8 Install Visual Studio 2022 version 17 or higher .Net Aspire Workload Container runtime such as Docker Desktop Install .Net 8 .Net 8 Install Visual Studio 2022 version 17 or higher Visual Studio 2022 .Net Aspire Workload Container runtime such as Docker Desktop Docker Desktop Objectives Learn how to create a starter project using .Net Aspire with the Azure Queue Storage. Github Sample : The solution structure is divided into the following projects Github Sample DotnetAspireChallenge.ApiService DotnetAspireChallenge.AppHost DotnetAspireChallenge.ServiceDefaults DotnetAspireChallenge.Web DotnetAspireChallenge.ApiService DotnetAspireChallenge.AppHost DotnetAspireChallenge.ServiceDefaults DotnetAspireChallenge.Web DotnetAspireChallenge.Web Getting Started Step 1: Install the following NuGet package Install the following Nuget package into the subsequent project “ DotnetAspireChallenge.AppHost ” DotnetAspireChallenge.AppHost dotnet add package Aspire.Hosting.Azure.Storage dotnet add package Aspire.Hosting.Azure.Storage In the above project, register the Azure storage, queue and emulator. var storage = builder.AddAzureStorage("storage");
    var queues = storage.AddQueues("queues"); var storage = builder.AddAzureStorage("storage");
    var queues = storage.AddQueues("queues"); **Note: ** The particular tag is used to skip version checks. Step 2: Install another NuGet package Install the following Nuget package into the subsequent project “ DotnetAspireChallenge.ApiService ” DotnetAspireChallenge.ApiService dotnet add package Aspire.Azure.Storage.Queues dotnet add package Aspire.Azure.Storage.Queues then register the context into the Program.cs file as follows builder.AddAzureQueueClient("queues"); builder.AddAzureQueueClient("queues"); Step 3: Create an extension class Create an extension class and register a minimal API send and receive method to demonstrate the QueueServiceClient usage in the API Service public static class AspireAzureQueueExtension
    {
        public static void MapAzureQueueEndpoint(this WebApplication app)
        {
            app.MapGet("/queue-send", async (QueueServiceClient queueServiceClient) =>
            {
                try
                {
                    var queueClient = queueServiceClient.GetQueueClient("test");
                    await queueClient.CreateIfNotExistsAsync();
    
                    if (await queueClient.ExistsAsync())
                    {
                        await queueClient.SendMessageAsync("Test Message ");
                        return Results.Ok($"Message sent to queue: test");
                    }
                    return Results.NotFound($"Queue not found: test");
                }
                catch (RequestFailedException e)
                {
                    Console.WriteLine("HTTP error code {0}: {1}", e.Status, e.ErrorCode);
                    Console.WriteLine(e.Message);
                    return Results.Problem($"HTTP error code {e.Status}: {e.Message}");
                }
            });
    
    
            app.MapGet("/queue-recieve", async (QueueServiceClient queueServiceClient) =>
            {
                try
                {
                    var queueClient = queueServiceClient.GetQueueClient("test");
                    if (await queueClient.ExistsAsync())
                    {
                        var response = await queueClient.ReceiveMessageAsync();
                        if (response?.Value != null)
                        {
                            var message = response.Value;
                            // Delete the message after processing
                            await queueClient.DeleteMessageAsync(message.MessageId, message.PopReceipt);
                            return Results.Ok($"Received message: {message.MessageText}");
                        }
                        return Results.Ok("No messages in the queue.");
                    }
                    return Results.NotFound($"Queue not found: test");
                }
                catch (RequestFailedException e)
                {
                    Console.WriteLine("HTTP error code {0}: {1}", e.Status, e.ErrorCode);
                    Console.WriteLine(e.Message);
                    return Results.Problem($"HTTP error code {e.Status}: {e.Message}");
                }
            });
        }
    } public static class AspireAzureQueueExtension
    {
        public static void MapAzureQueueEndpoint(this WebApplication app)
        {
            app.MapGet("/queue-send", async (QueueServiceClient queueServiceClient) =>
            {
                try
                {
                    var queueClient = queueServiceClient.GetQueueClient("test");
                    await queueClient.CreateIfNotExistsAsync();
    
                    if (await queueClient.ExistsAsync())
                    {
                        await queueClient.SendMessageAsync("Test Message ");
                        return Results.Ok($"Message sent to queue: test");
                    }
                    return Results.NotFound($"Queue not found: test");
                }
                catch (RequestFailedException e)
                {
                    Console.WriteLine("HTTP error code {0}: {1}", e.Status, e.ErrorCode);
                    Console.WriteLine(e.Message);
                    return Results.Problem($"HTTP error code {e.Status}: {e.Message}");
                }
            });
    
    
            app.MapGet("/queue-recieve", async (QueueServiceClient queueServiceClient) =>
            {
                try
                {
                    var queueClient = queueServiceClient.GetQueueClient("test");
                    if (await queueClient.ExistsAsync())
                    {
                        var response = await queueClient.ReceiveMessageAsync();
                        if (response?.Value != null)
                        {
                            var message = response.Value;
                            // Delete the message after processing
                            await queueClient.DeleteMessageAsync(message.MessageId, message.PopReceipt);
                            return Results.Ok($"Received message: {message.MessageText}");
                        }
                        return Results.Ok("No messages in the queue.");
                    }
                    return Results.NotFound($"Queue not found: test");
                }
                catch (RequestFailedException e)
                {
                    Console.WriteLine("HTTP error code {0}: {1}", e.Status, e.ErrorCode);
                    Console.WriteLine(e.Message);
                    return Results.Problem($"HTTP error code {e.Status}: {e.Message}");
                }
            });
        }
    } and finally, register in the Program.cs file app.MapAzureQueueEndpoint(); app.MapAzureQueueEndpoint(); Add additional connection string properties using the JSON syntax {
      "Aspire": {
        "Azure": {
          "Storage": {
            "Queues": {
              "DisableHealthChecks": true,
              "DisableTracing": false,
              "ClientOptions": {
                "Diagnostics": {
                  "ApplicationId": "myapp"
                }
              }
            }
          }
        }
      }
    } {
      "Aspire": {
        "Azure": {
          "Storage": {
            "Queues": {
              "DisableHealthChecks": true,
              "DisableTracing": false,
              "ClientOptions": {
                "Diagnostics": {
                  "ApplicationId": "myapp"
                }
              }
            }
          }
        }
      }
    } Congratulations..!! You’ve successfully integrated the Azure Queue Storage component into the .Net Aspire project. Github Project GitHub - ssukhpinder/DotnetAspireChallenge: 10 Day .Net Aspire Challenge GitHub - ssukhpinder/DotnetAspireChallenge: 10 Day .Net Aspire Challenge More Cheatsheets Cheat Sheets — .Net Cheat Sheets — .Net C# Programming🚀 Thank you for being a part of the C# community! Before you leave: Follow us: Youtube | X | LinkedIn | Dev.to Visit our other platforms: GitHub More content at C# Programming Youtube X LinkedIn Dev.to GitHub C# Programming

This story contains new, firsthand information uncovered by the writer.

This writer has a vested interest be it monetary, business, or otherwise, with 1 or more of the products or companies mentioned within.

Walkthroughs, tutorials, guides, and tips. This story will teach you how to do something new or how to do something better.

The 10-Day .Net Aspire Challenge - Day 8: Azure Queue Storage

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

10-Day .Net Aspire Challenge: Day 1 - An Introduction to .Net Aspire

C# 8.0 Indices and Ranges

5 Tips to Improve Your Productivity in C# 8.0

68 Stories To Learn About Dotnet Core

A Guide to Running ASP.NET Core & SQL Server from Docker

A Guide to Using Scoped Services Inside Singletons

10-Day .Net Aspire Challenge: Day 1 - An Introduction to .Net Aspire

C# 8.0 Indices and Ranges

5 Tips to Improve Your Productivity in C# 8.0

68 Stories To Learn About Dotnet Core

A Guide to Running ASP.NET Core & SQL Server from Docker

A Guide to Using Scoped Services Inside Singletons

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps