Aspire.Hosting.Azure.Storage 9.4.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Aspire.Hosting.Azure.Storage --version 9.4.0
                    


                    

                
NuGet\Install-Package Aspire.Hosting.Azure.Storage -Version 9.4.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="9.4.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="9.4.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 9.4.0
                    


                    

                
#r "nuget: Aspire.Hosting.Azure.Storage, 9.4.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@9.4.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=9.4.0
                    


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

Aspire.Hosting.Azure.Storage library

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

Getting started

Prerequisites

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

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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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 .NET Aspire.
Aspire.Hosting.Azure.EventHubs

Azure Event Hubs resource types for .NET Aspire.
EAVFramework.Extensions.Aspire.Hosting

Aspire Hosting package for EAVFramework

GitHub repositories (5)

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

Repository Stars
dotnet/aspire-samples
erwinkramer/bank-api
The Bank API is a design reference project suitable to bootstrap development for a compliant and modern API.
foxminchan/BookWorm
The practical implementation of .NET Aspire using Microservices
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
marinasundstrom/YourBrand
Prototype enterprise system for e-commerce and consulting services