Skip to content
Docs Try Aspire

ConnectionStringBuilderExtensions Methods

Class Methods 2 members
Provides extension methods for adding connection string resources to an application.
AddConnectionString(IDistributedApplicationBuilder, string, ReferenceExpression) Section titled AddConnectionString(IDistributedApplicationBuilder, string, ReferenceExpression) extension IResourceBuilder<ConnectionStringResource>
Adds a connection string resource to the distributed application with the specified expression.
public static class ConnectionStringBuilderExtensions
{
public static IResourceBuilder<ConnectionStringResource> AddConnectionString(
this IDistributedApplicationBuilder builder,
string name,
ReferenceExpression connectionStringExpression)
{
// ...
}
}
builder IDistributedApplicationBuilder Distributed application builder
name string The name of the resource.
connectionStringExpression ReferenceExpression The connection string expression.
IResourceBuilder<ConnectionStringResource> An ApplicationModel.IResourceBuilder`1 instance.
This method also enables appending custom data to the connection string based on other resources that expose connection strings.
var builder = DistributedApplication.CreateBuilder(args);
var apiKey = builder.AddParameter("apiKey", secret: true);
var cs = builder.AddConnectionString(
"cs",
ReferenceExpression.Create($"Endpoint=http://something;Key={apiKey}"));
var backend = builder
.AddProject<Projects.Backend>("backend")
.WithReference(cs)
.WaitFor(database);
builder.Build().Run();
AddConnectionString(IDistributedApplicationBuilder, string, Action<ReferenceExpressionBuilder>) Section titled AddConnectionString(IDistributedApplicationBuilder, string, Action<ReferenceExpressionBuilder>) extension IResourceBuilder<ConnectionStringResource>
Adds a connection string resource to the distributed application with the specified expression.
public static class ConnectionStringBuilderExtensions
{
public static IResourceBuilder<ConnectionStringResource> AddConnectionString(
this IDistributedApplicationBuilder builder,
string name,
Action<ReferenceExpressionBuilder> connectionStringBuilder)
{
// ...
}
}
builder IDistributedApplicationBuilder The distributed application builder.
name string The name of the resource.
connectionStringBuilder Action<ReferenceExpressionBuilder> The callback to configure the connection string expression.
IResourceBuilder<ConnectionStringResource> An ApplicationModel.IResourceBuilder`1 instance.
This method also enables appending custom data to the connection string based on other resources that expose connection strings.
var builder = DistributedApplication.CreateBuilder(args);
var apiKey = builder.AddParameter("apiKey", secret: true);
var cs = builder.AddConnectionString("cs", b => b.Append($"Endpoint=http://something;Key={apiKey}"));
var backend = builder
.AddProject<Projects.Backend>("backend")
.WithReference(cs)
.WaitFor(database);
builder.Build().Run();