ConnectionStringBuilderExtensions Methods

Docs / Reference / Search C# APIs / Aspire.Hosting / ConnectionStringBuilderExtensions / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting ConnectionStringBuilderExtensions Methods

Class Methods 2 members

Provides extension methods for adding connection string resources to an application.

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)
    {
        // ...
    }
}

ConnectionStringBuilderExtensions.cs#L42-L115

Parameters

builder IDistributedApplicationBuilder Distributed application builder

name string The name of the resource.

connectionStringExpression ReferenceExpression The connection string expression.

Returns

IResourceBuilder<ConnectionStringResource> An ApplicationModel.IResourceBuilder`1 instance.

Remarks

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>) 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)
    {
        // ...
    }
}

ConnectionStringBuilderExtensions.cs#L146-L148

Parameters

builder IDistributedApplicationBuilder

name string

connectionStringBuilder Action<ReferenceExpressionBuilder>

Remarks

This method also enables appending custom data to the connection string based on other resources that expose connection strings. Distributed application builder The name of the resource. The callback to configure the connection string expression. An ApplicationModel.IResourceBuilder`1 instance.

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();