Aspire.Hosting.Azure.Storage 9.4.0
Aspire.Hosting.Azure.Storage library
Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure Storage.
Getting started
Prerequisites
- Azure subscription - create one for free
Install the package
Install the .NET Aspire Azure Storage Hosting library with NuGet:
dotnet add package Aspire.Hosting.Azure.Storage
Configure Azure Provisioning for local development
Adding Azure resources to the .NET Aspire application model will automatically enable development-time provisioning for Azure resources so that you don't need to configure them manually. Provisioning requires a number of settings to be available via .NET configuration. Set these values in user secrets in order to allow resources to be configured automatically.
{
"Azure": {
"SubscriptionId": "<your subscription id>",
"ResourceGroupPrefix": "<prefix for the resource group>",
"Location": "<azure location>"
}
}
NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.
Usage example
In the AppHost.cs file of AppHost, add a Blob (can use tables or queues also) Storage connection and consume the connection using the following methods:
var blobs = builder.AddAzureStorage("storage").AddBlobs("blobs");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(blobs);
The WithReference method passes that connection information into a connection string named blobs in the MyService project. In the Program.cs file of MyService, the connection can be consumed using the client library Aspire.Azure.Storage.Blobs:
builder.AddAzureBlobServiceClient("blobs");
Creating and using blob containers and queues directly
You can create and use blob containers and queues directly by adding them to your storage resource. This allows you to provision and reference specific containers or queues for your services.
Adding a blob container
var storage = builder.AddAzureStorage("storage");
var container = storage.AddBlobContainer("my-container");
You can then pass the container reference to a project:
builder.AddProject<Projects.MyService>()
.WithReference(container);
In your service, consume the container using:
builder.AddAzureBlobContainerClient("my-container");
This will register a singleton of type BlobContainerClient.
Adding a queue
var storage = builder.AddAzureStorage("storage");
var queue = storage.AddQueue("my-queue");
Pass the queue reference to a project:
builder.AddProject<Projects.MyService>()
.WithReference(queue);
In your service, consume the queue using:
builder.AddAzureQueue("my-queue");
This will register a singleton of type QueueClient.
This approach allows you to define and use specific blob containers and queues as first-class resources in your Aspire application model.
Additional documentation
- https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Blobs/README.md
- https://github.com/dotnet/aspire/tree/main/src/Components/README.md
Feedback & contributing
No packages depend on Aspire.Hosting.Azure.Storage.
.NET 8.0
- Aspire.Hosting.Azure (>= 9.4.0)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.18)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.3)
- Polly.Core (>= 8.6.2)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.11)
- System.IO.Hashing (>= 9.0.7)
- KubernetesClient (>= 17.0.4)
- JsonPatch.Net (>= 3.3.0)
- Humanizer.Core (>= 2.14.1)
- Azure.ResourceManager.Authorization (>= 1.1.4)
- Azure.Provisioning (>= 1.2.1)
- Azure.Provisioning.Storage (>= 1.1.2)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.47.0)
- Azure.Identity (>= 1.14.2)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Grpc.Tools (>= 2.72.0)
- Azure.ResourceManager.KeyVault (>= 1.3.2)
- Azure.ResourceManager.Resources (>= 1.11.0)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Azure.Storage.Blobs (>= 12.24.1)
- Azure.Storage.Queues (>= 12.22.0)
- Google.Protobuf (>= 3.31.1)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- AspNetCore.HealthChecks.Azure.Storage.Queues (>= 9.0.0)
- AspNetCore.HealthChecks.Azure.Storage.Blobs (>= 9.0.0)
| Version | Downloads | Last updated |
|---|---|---|
| 13.0.2 | 0 | 04.12.2025 |
| 13.0.1 | 0 | 26.11.2025 |
| 13.0.0 | 0 | 11.11.2025 |
| 9.5.2 | 0 | 23.10.2025 |
| 9.5.1 | 0 | 03.10.2025 |
| 9.5.0 | 0 | 25.09.2025 |
| 9.4.2 | 1 | 05.09.2025 |
| 9.4.1 | 1 | 05.09.2025 |
| 9.4.0 | 1 | 05.09.2025 |
| 9.3.1 | 1 | 05.09.2025 |
| 9.3.0 | 1 | 05.09.2025 |
| 9.2.1 | 1 | 05.09.2025 |
| 9.2.0 | 1 | 05.09.2025 |
| 9.1.0 | 2 | 04.09.2025 |
| 9.0.0 | 1 | 05.09.2025 |
| 9.0.0-rc.1.24511.1 | 1 | 05.09.2025 |
| 8.2.2 | 1 | 05.09.2025 |
| 8.2.1 | 1 | 05.09.2025 |
| 8.2.0 | 1 | 05.09.2025 |
| 8.1.0 | 1 | 05.09.2025 |
| 8.0.2 | 1 | 05.09.2025 |
| 8.0.1 | 1 | 05.09.2025 |
| 8.0.0 | 1 | 05.09.2025 |
| 8.0.0-preview.7.24251.11 | 1 | 05.09.2025 |
| 8.0.0-preview.6.24214.1 | 1 | 05.09.2025 |
| 8.0.0-preview.5.24201.12 | 1 | 05.09.2025 |