AspireAzureNpgsqlExtensions.AddAzureNpgsqlDataSource Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Registers Npgsql.NpgsqlDataSource service for connecting PostgreSQL database with Npgsql client. Configures health check, logging and telemetry for the Npgsql client.
public static void AddAzureNpgsqlDataSource(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string connectionName, Action<Aspire.Azure.Npgsql.AzureNpgsqlSettings>? configureSettings = default, Action<Npgsql.NpgsqlDataSourceBuilder>? configureDataSourceBuilder = default);static member AddAzureNpgsqlDataSource : Microsoft.Extensions.Hosting.IHostApplicationBuilder * string * Action<Aspire.Azure.Npgsql.AzureNpgsqlSettings> * Action<Npgsql.NpgsqlDataSourceBuilder> -> unit<Extension()>
Public Sub AddAzureNpgsqlDataSource (builder As IHostApplicationBuilder, connectionName As String, Optional configureSettings As Action(Of AzureNpgsqlSettings) = Nothing, Optional configureDataSourceBuilder As Action(Of NpgsqlDataSourceBuilder) = Nothing)Parameters
- builder
- IHostApplicationBuilder
The IHostApplicationBuilder to read config from and add services to.
- connectionName
- String
A name used to retrieve the connection string from the ConnectionStrings configuration section.
- configureSettings
- Action<AzureNpgsqlSettings>
An optional delegate that can be used for customizing options. It's invoked after the settings are read from the configuration.
- configureDataSourceBuilder
- Action<Npgsql.NpgsqlDataSourceBuilder>
An optional delegate that can be used for customizing the Npgsql.NpgsqlDataSourceBuilder.
Exceptions
Thrown if mandatory builder is null.
Thrown when mandatory ConnectionString is not provided or the Credential is invalid.
Remarks
Reads the configuration from "Aspire:Npgsql" section.