builder.AddAzureQueueServiceClient("queueConnectionName");

And then the connection string will be retrieved from the ConnectionStrings configuration section. Two connection formats are supported:

Service URI

The recommended approach is to use a ServiceUri, which works with the AzureStorageQueuesSettings.Credential property to establish a connection. If no credential is configured, the DefaultAzureCredential is used.

{
  "ConnectionStrings": {
    "queueConnectionName": "https://{account_name}.queue.core.windows.net/"
  }
}

Connection string

Alternatively, an Azure Storage connection string can be used.

{
  "ConnectionStrings": {
    "queueConnectionName": "AccountName=myaccount;AccountKey=myaccountkey"
  }
}

Use configuration providers

The .NET Aspire Azure Storage Queues library supports Microsoft.Extensions.Configuration. It loads the AzureStorageQueuesSettings and QueueClientOptions from configuration by using the Aspire:Azure:Storage:Queues key. Example appsettings.json that configures some of the options:

{
  "Aspire": {
    "Azure": {
      "Storage": {
        "Queues": {
          "DisableHealthChecks": true,
          "DisableTracing": false,
          "ClientOptions": {
            "Diagnostics": {
              "ApplicationId": "myapp"
            }
          }
        }
      }
    }
  }
}

Use inline delegates

You can also pass the Action<AzureStorageQueuesSettings> configureSettings delegate to set up some or all the options inline, for example to disable health checks from code:

builder.AddAzureQueueServiceClient("queue", settings => settings.DisableHealthChecks = true);

You can also setup the QueueClientOptions using the optional Action<IAzureClientBuilder<QueueServiceClient, QueueClientOptions>> configureClientBuilder parameter of the AddAzureQueueClient method. For example, to set the first part of "User-Agent" headers for all requests issues by this client:

builder.AddAzureQueueServiceClient("queue", configureClientBuilder: clientBuilder => clientBuilder.ConfigureOptions(options => options.Diagnostics.ApplicationId = "myapp"));

AppHost extensions

In your AppHost project, install the Aspire Azure Storage Hosting library with NuGet:

dotnet add package Aspire.Hosting.Azure.Storage

Then, in the AppHost.cs file of AppHost, add a Storage Queue connection and consume the connection using the following methods:

var queue = builder.ExecutionContext.IsPublishMode
    ? builder.AddAzureStorage("storage").AddQueues("queue")
    : builder.AddConnectionString("queue");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(queue);

The AddQueues method adds an Azure Storage queue to the builder. Or AddConnectionString can be used to read connection information from the AppHost's configuration (for example, from "user secrets") under the ConnectionStrings:queue config key. The WithReference method passes that connection information into a connection string named queue in the MyService project. In the Program.cs file of MyService, the connection can be consumed using:

builder.AddAzureQueueServiceClient("queue");

Additional documentation

• https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Queues/README.md
• https://github.com/dotnet/aspire/tree/main/src/Components/README.md

Feedback & contributing

https://github.com/dotnet/aspire