Aspire.Hosting.Azure.Storage 8.2.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Aspire.Hosting.Azure.Storage --version 8.2.0                
NuGet\Install-Package Aspire.Hosting.Azure.Storage -Version 8.2.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="8.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Aspire.Hosting.Azure.Storage --version 8.2.0                
#r "nuget: Aspire.Hosting.Azure.Storage, 8.2.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.
// Install Aspire.Hosting.Azure.Storage as a Cake Addin
#addin nuget:?package=Aspire.Hosting.Azure.Storage&version=8.2.0

// Install Aspire.Hosting.Azure.Storage as a Cake Tool
#tool nuget:?package=Aspire.Hosting.Azure.Storage&version=8.2.0                

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 Program.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.AddAzureBlobClient("blobs");

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

NuGet packages (2)

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

Package Downloads
Aspire.Hosting.Azure.EventHubs

Azure Event Hubs resource types for .NET Aspire.

Aspire.Hosting.Azure.Functions

Azure Functions resource types for .NET Aspire.

GitHub repositories (3)

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

Repository Stars
dotnet/aspire-samples
platformplatform/PlatformPlatform
Alpha state. A platform designed for building enterprise-grade, multi-tenant products using Azure, .NET, React, TypeScript, Infrastructure as Code, etc.
erwinkramer/bank-api
The Bank API is a design reference project suitable to bootstrap development for a compliant and modern API.
Version Downloads Last updated
9.0.0 11,425 11/12/2024
9.0.0-rc.1.24511.1 3,777 10/15/2024
8.2.2 8,864 10/24/2024
8.2.1 14,049 9/26/2024
8.2.0 28,147 8/29/2024
8.1.0 12,616 7/23/2024
8.0.2 7,957 6/28/2024
8.0.1 13,904 5/21/2024
8.0.0 1,198 5/21/2024
8.0.0-preview.7.24251.11 1,818 5/7/2024
8.0.0-preview.6.24214.1 4,507 4/23/2024
8.0.0-preview.5.24201.12 4,098 4/9/2024