Aspire.Hosting.Azure.PostgreSQL 13.5.2

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


                    

                
NuGet\Install-Package Aspire.Hosting.Azure.PostgreSQL -Version 13.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="13.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="13.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 13.5.2
                    


                    

                
#r "nuget: Aspire.Hosting.Azure.PostgreSQL, 13.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@13.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=13.5.2
                    


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

Azure Database for PostgreSQL hosting integration

Use this integration to model, configure, and orchestrate Azure Database for PostgreSQL in an Aspire solution.

Getting started

Prerequisites

Add the integration

From your AppHost directory, add the Aspire.Hosting.Azure.PostgreSQL integration with the Aspire CLI:

aspire add Aspire.Hosting.Azure.PostgreSQL

Configure Azure Provisioning for local development

Adding Azure resources to the AppHost 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 AppHost configuration. From your AppHost directory, set these values with aspire secret set:

aspire secret set Azure:SubscriptionId "<your subscription id>"
aspire secret set Azure:ResourceGroupPrefix "<prefix for the resource group>"
aspire secret set Azure: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, register a Postgres database and reference it from another resource with either C# or TypeScript:

C#

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

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

TypeScript

const postgresdb = await builder.addAzurePostgresFlexibleServer("pg")
                        .addDatabase("postgresdb");

const myService = await builder.addNodeApp("myService", "../my-service", "server.js")
                       .withReference(postgresdb);

Connection Properties

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

Azure PostgreSQL flexible server

The Azure PostgreSQL server resource exposes the following connection properties:

Property Name Description
Host The hostname for the PostgreSQL server
Port The PostgreSQL port (fixed at 5432 in Azure Flexible Server)
Uri The connection URI for the server, with the format postgresql://{Username}:{Password}@{Host} (credentials omitted when not applicable)
JdbcConnectionString JDBC-format connection string for the server, with the format jdbc:postgresql://{Host}?sslmode=require&authenticationPluginClassName=com.azure.identity.extensions.jdbc.postgresql.AzurePostgresqlAuthenticationPlugin
Username Present when password authentication is enabled; the configured administrator username
Password Present when password authentication is enabled; the configured administrator password

Azure PostgreSQL database

The Azure PostgreSQL database resource inherits all properties from its parent server and adds:

Property Name Description
DatabaseName The name of the database
Uri The database-specific connection URI, with the format postgresql://{Username}:{Password}@{Host}/{DatabaseName} (credentials omitted when not applicable)
JdbcConnectionString JDBC-format connection string for the database, with the format jdbc:postgresql://{Host}/{DatabaseName}?sslmode=require&authenticationPluginClassName=com.azure.identity.extensions.jdbc.postgresql.AzurePostgresqlAuthenticationPlugin

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

Additional documentation

Feedback & contributing

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

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (4)

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

Repository Stars
jasontaylordev/CleanArchitecture
Clean Architecture Solution Template for ASP.NET Core
mehdihadeli/food-delivery-microservices
🍔 A practical and cloud-native food delivery microservices, built with .Net Aspire, .Net 10, Wolverine, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
foxminchan/BookWorm
The practical implementation of Aspire using Microservices, AI-Agents
FritzAndFriends/TagzApp
An application that discovers content on social media for hashtags
Version Downloads Last Updated
13.5.2 180 8/21/2026
13.5.1 862 8/20/2026
13.5.0 1,928 8/18/2026
13.4.6 112,962 6/19/2026
13.4.5 9,818 6/17/2026
13.4.4 16,941 6/15/2026
13.4.3 12,006 6/8/2026
13.4.2 8,944 6/3/2026
13.4.1 514 6/3/2026
13.4.0 3,883 6/1/2026
13.3.5 22,672 5/21/2026
13.3.4 2,486 5/19/2026
13.3.3 5,680 5/15/2026
13.3.2 5,097 5/14/2026
13.3.1 2,549 5/12/2026
13.3.0 21,543 5/7/2026
13.2.4 27,261 4/24/2026
13.2.3 9,515 4/21/2026
13.2.2 32,251 4/8/2026
13.2.1 13,465 3/31/2026
Loading failed