Aspire.Hosting.Azure.PostgreSQL 9.5.2

Prefix Reserved

dotnet add package Aspire.Hosting.Azure.PostgreSQL --version 9.5.2

NuGet\Install-Package Aspire.Hosting.Azure.PostgreSQL -Version 9.5.2

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.PostgreSQL" Version="9.5.2" />

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

<PackageVersion Include="Aspire.Hosting.Azure.PostgreSQL" Version="9.5.2" />
                    

                            Directory.Packages.props

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

                            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.PostgreSQL --version 9.5.2

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

#r "nuget: Aspire.Hosting.Azure.PostgreSQL, 9.5.2"

#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.PostgreSQL@9.5.2

#: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.PostgreSQL&version=9.5.2
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Hosting.Azure.PostgreSQL&version=9.5.2
                    

                            Install as a Cake Tool

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

Aspire.Hosting.Azure.PostgreSQL library

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

Getting started

Prerequisites

Azure subscription - create one for free

Install the package

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

dotnet add package Aspire.Hosting.Azure.PostgreSQL

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 AppHost.cs file of AppHost, register a Postgres database and consume the connection using the following methods:

var postgresdb = builder.AddAzurePostgresFlexibleServer("pg")
                        .AddDatabase("postgresdb");

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

The WithReference method configures a connection in the MyService project named postgresdb. By default, AddAzurePostgresFlexibleServer configures Microsoft Entra ID authentication. This requires changes to applications that need to connect to these resources. In the Program.cs file of MyService, the database connection can be consumed using the client library Aspire.Azure.Npgsql or Aspire.Azure.Npgsql.EntityFrameworkCore.PostgreSQL:

builder.AddAzureNpgsqlDataSource("postgresdb");

Additional documentation

Feedback & contributing

https://github.com/dotnet/aspire

*Postgres, PostgreSQL and the Slonik Logo are trademarks or registered trademarks of the PostgreSQL Community Association of Canada, and used with their permission.

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 (>= 9.5.2)
- Aspire.Hosting.Azure.KeyVault (>= 9.5.2)
- Aspire.Hosting.PostgreSQL (>= 9.5.2)
- AspNetCore.HealthChecks.NpgSql (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.47.3)
- Azure.Identity (>= 1.15.0)
- Azure.Provisioning (>= 1.3.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.PostgreSql (>= 1.1.1)
- Azure.ResourceManager.Authorization (>= 1.1.5)
- Azure.ResourceManager.KeyVault (>= 1.3.2)
- Azure.ResourceManager.Resources (>= 1.11.1)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Google.Protobuf (>= 3.32.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 (>= 17.0.14)
- 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.20)
- 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.3)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.11)
- System.IO.Hashing (>= 9.0.8)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (3)

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

Repository	Stars
mehdihadeli/food-delivery-microservices 🍔 A practical and cloud-native food delivery microservices, built with .Net Aspire, .Net 9, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.	938
foxminchan/BookWorm The practical implementation of .NET Aspire using Microservices, AI-Agents	442
FritzAndFriends/TagzApp An application that discovers content on social media for hashtags	128

Version	Downloads	Last Updated
9.5.2	18	10/23/2025
9.5.1	6,501	10/3/2025
9.5.0	4,522	9/25/2025
9.4.2	7,760	9/2/2025
9.4.1	7,839	8/12/2025
9.4.0	5,101	7/29/2025
9.3.1	21,737	6/10/2025
9.3.0	12,449	5/19/2025
9.2.1	8,914	4/24/2025
9.2.0	7,053	4/10/2025
9.1.0	20,560	2/25/2025
9.0.0	25,965	11/12/2024
9.0.0-rc.1.24511.1	1,578	10/15/2024
8.2.2	2,918	10/24/2024
8.2.1	2,306	9/26/2024
8.2.0	3,191	8/29/2024
8.1.0	1,428	7/23/2024
8.0.2	808	6/28/2024
8.0.1	2,071	5/21/2024
8.0.0	431	5/21/2024
8.0.0-preview.7.24251.11	280	5/7/2024
8.0.0-preview.6.24214.1	405	4/23/2024
8.0.0-preview.5.24201.12	348	4/9/2024