ConnectionStringBuilderExtensions Methods

ClassMethods2 members

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

AddConnectionString(IDistributedApplicationBuilder, string, ReferenceExpression)extensionIResourceBuilder<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#L43-L116

Parameters

builderIDistributedApplicationBuilderDistributed application builder

namestringThe name of the resource.

connectionStringExpressionReferenceExpressionThe 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>)extensionIResourceBuilder<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#L148-L150