ParameterResourceBuilderExtensions.AddConnectionString Method

Definition

Adds a parameter to the distributed application but wrapped in a resource with a connection string for use with WithReference<TDestination>(IResourceBuilder<TDestination>, IResourceBuilder<IResourceWithConnectionString>, String, Boolean)

C#
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.IResourceWithConnectionString> AddConnectionString(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, string? environmentVariableName = default);

Parameters

builder
IDistributedApplicationBuilder

Distributed application builder

name
String

Name of parameter resource. The value of the connection string is read from the "ConnectionStrings:{resourcename}" configuration section, for example in appsettings.json or user secrets

environmentVariableName
String

Environment variable name to set when WithReference is used.

Returns

Resource builder for the parameter.

Exceptions

Applies to

Produit Versions
.NET Aspire 8.0.0, 9.0.0, 9.1.0