Aspire.Hosting.Azure.Storage 13.1.0

Prefix Reserved

dotnet add package Aspire.Hosting.Azure.Storage --version 13.1.0

NuGet\Install-Package Aspire.Hosting.Azure.Storage -Version 13.1.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Aspire.Hosting.Azure.Storage" Version="13.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Aspire.Hosting.Azure.Storage" Version="13.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Aspire.Hosting.Azure.Storage" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Aspire.Hosting.Azure.Storage --version 13.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Aspire.Hosting.Azure.Storage, 13.1.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Aspire.Hosting.Azure.Storage@13.1.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Aspire.Hosting.Azure.Storage&version=13.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Hosting.Azure.Storage&version=13.1.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Aspire.Hosting.Azure.Storage library

Provides extension methods and resource definitions for an Aspire AppHost to configure Azure Storage.

Getting started

Prerequisites

Azure subscription - create one for free

Install the package

Install the 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 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.

Connection Properties

When you reference Azure Storage resources using WithReference, the following connection properties are made available to the consuming project:

Azure Storage

The Azure Storage account resource doesn't expose any connection property, reference sub-resources:

Blob Storage

The Blob Storage resource exposes the following connection properties:

Property Name	Description
`Uri`	The URI of the blob storage service, with the format `https://mystorageaccount.blob.core.windows.net/`
`ConnectionString`	Emulator only. The connection string for the blob storage service

Blob Container

The Blob Container resource inherits all properties from its parent AzureBlobStorageResource and adds:

Property Name	Description
`BlobContainerName`	The name of the blob container

Queue Storage

The Queue Storage resource exposes the following connection properties:

Property Name	Description
`Uri`	The URI of the queue storage service, with the format `https://mystorageaccount.queue.core.windows.net/`
`ConnectionString`	Emulator only. The connection string for the queue storage service

Queue

The Queue resource inherits all properties from its parent AzureQueueStorageResource and adds:

Property Name	Description
`QueueName`	The name of the queue
`ConnectionString`	Emulator only. The connection string for the table storage service

Table Storage

The Table Storage resource exposes the following connection properties:

Property Name	Description
`Uri`	The URI of the table storage service, with the format `https://mystorageaccount.table.core.windows.net/`
`ConnectionString`	The connection string for the table storage service

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called queue1 becomes QUEUE1_URI.

Additional documentation

Feedback & contributing

https://github.com/dotnet/aspire

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Aspire.Hosting.Azure (>= 13.1.0)
- AspNetCore.HealthChecks.Azure.Storage.Blobs (>= 9.0.0)
- AspNetCore.HealthChecks.Azure.Storage.Queues (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.50.0)
- Azure.Identity (>= 1.17.0)
- Azure.Provisioning (>= 1.4.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.Storage (>= 1.1.2)
- Azure.ResourceManager.Authorization (>= 1.1.6)
- Azure.ResourceManager.KeyVault (>= 1.3.3)
- Azure.ResourceManager.Resources (>= 1.11.1)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Azure.Storage.Blobs (>= 12.26.0)
- Azure.Storage.Queues (>= 12.24.0)
- Google.Protobuf (>= 3.33.0)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.Tools (>= 2.72.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 18.0.5)
- 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.22)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.1)
- 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.4)
- Polly.Core (>= 8.6.4)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 9.0.10)

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Aspire.Hosting.Azure.Storage:

Package	Downloads
Aspire.Hosting.Azure.Functions Azure Functions resource types for Aspire.	462.1K
Aspire.Hosting.Azure.EventHubs Azure Event Hubs resource types for Aspire.	130.0K
EAVFramework.Extensions.Aspire.Hosting Aspire Hosting package for EAVFramework	7.4K

GitHub repositories (10)

Showing the top 10 popular GitHub repositories that depend on Aspire.Hosting.Azure.Storage:

Repository	Stars
bitfoundation/bitplatform Build all of your apps using what you already know and love ❤️	1.3K
dotnet/aspire-samples	1.1K
erwinkramer/bank-api The Bank API is a design reference project suitable to bootstrap development for a compliant and modern API.	776
microsoft/AzUrlShortener An simple and easy Url Shortener	578
petabridge/akkadotnet-code-samples Akka.NET professional reference code samples	560
CommunityToolkit/Aspire A community project with additional components and extensions for Aspire	552
foxminchan/BookWorm The practical implementation of Aspire using Microservices, AI-Agents	464
platformplatform/PlatformPlatform A platform designed for building enterprise-grade, multi-tenant products using Azure, .NET, React, TypeScript, Infrastructure as Code, etc.	392
J-Tech-Japan/Sekiban Sekiban - an Opinionated Event Sourcing and CQRS Framework using C#. It can store data into Azure Cosmos DB, AWS Dynamo DB or Postgres	328
marinasundstrom/YourBrand Prototype enterprise system for e-commerce and consulting services	112

Version	Downloads	Last Updated
13.1.0	22,483	12/17/2025
13.0.2	41,380	12/4/2025
13.0.1	24,264	11/26/2025
13.0.0	77,222	11/11/2025
9.5.2	114,701	10/23/2025
9.5.1	113,761	10/3/2025
9.5.0	55,432	9/25/2025
9.4.2	93,659	9/2/2025
9.4.1	90,536	8/12/2025
9.4.0	69,656	7/29/2025
9.3.1	200,047	6/10/2025
9.3.0	106,805	5/19/2025
9.2.1	86,792	4/24/2025
9.2.0	69,007	4/10/2025
9.1.0	166,622	2/25/2025
9.0.0	239,125	11/12/2024
9.0.0-rc.1.24511.1	6,387	10/15/2024
8.2.2	28,499	10/24/2024
8.2.1	22,073	9/26/2024
8.2.0	36,656	8/29/2024
8.1.0	14,438	7/23/2024
8.0.2	9,955	6/28/2024
8.0.1	17,952	5/21/2024
8.0.0	2,455	5/21/2024
8.0.0-preview.7.24251.11	2,041	5/7/2024
8.0.0-preview.6.24214.1	4,793	4/23/2024
8.0.0-preview.5.24201.12	4,271	4/9/2024