Skip to main content
net8.0

Azure AppConfiguration resource types for .NET Aspire.

Published
Oct 15, 2024
2y ago
Total Downloads
655.5K
655,477

Deprecated Package Version

Reason: Other, Legacy

This version is out of support and is no longer maintained. Please upgrade to the latest version. See our support policy for details: https://aka.ms/dotent/aspire/support

Install

dotnet add package Aspire.Hosting.Azure.AppConfiguration --version 9.0.0-rc.1.24511.1
ProductVersions
.NET
net8.0

README

Aspire.Hosting.Azure.AppConfiguration library

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

Getting started

Prerequisites

Install the package

In your AppHost project, install the .NET Aspire Azure App Configuration Hosting library with NuGet:

dotnet add package Aspire.Hosting.Azure.AppConfiguration

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

Then, in the Program.cs file of AppHost, add an App Configuration connection and consume the connection using the following methods:

var appConfig = builder.AddAzureAppConfiguration("config");

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

NOTE: Consider setting the name of your resource to something other than "config" or "appconfig". Even though during deployment a random suffix will be added it is still possible to get a name collision.

Additional documentation

Feedback & contributing

https://github.com/dotnet/aspire

Changes from Previous Version

Adoption Assessment

A verified publisher signal is available. Assess fit from the package's supported frameworks, license and dependency graph rather than popularity alone.

This version is marked prerelease. Validate its API and upgrade path before production use.NuGet marks this package as deprecated. Review the publisher's migration guidance before adopting it.Compatibility metadata lists 1 target framework; confirm the exact target used by your application.The published metadata declares 31 direct dependency entries across framework groups. Inspect the resolved dependency graph for your target framework.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.