ConnectionStringBuilderExtensions.AddConnectionString 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.
Overloads
| AddConnectionString(IDistributedApplicationBuilder, String, ReferenceExpression) |
Adds a connection string resource to the distributed application with the specified expression. |
| AddConnectionString(IDistributedApplicationBuilder, String, Action<ReferenceExpressionBuilder>) |
Adds a connection string resource to the distributed application with the specified expression. |
AddConnectionString(IDistributedApplicationBuilder, String, ReferenceExpression)
Adds a connection string resource to the distributed application with the specified expression.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ConnectionStringResource> AddConnectionString(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, Aspire.Hosting.ApplicationModel.ReferenceExpression connectionStringExpression);static member AddConnectionString : Aspire.Hosting.IDistributedApplicationBuilder * string * Aspire.Hosting.ApplicationModel.ReferenceExpression -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ConnectionStringResource><Extension()>
Public Function AddConnectionString (builder As IDistributedApplicationBuilder, name As String, connectionStringExpression As ReferenceExpression) As IResourceBuilder(Of ConnectionStringResource)Parameters
- builder
- IDistributedApplicationBuilder
Distributed application builder
- name
- String
The name of the resource.
- connectionStringExpression
- ReferenceExpression
The connection string expression.
Returns
An IResourceBuilder<T> instance.
Examples
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();
Remarks
This method also enables appending custom data to the connection string based on other resources that expose connection strings.
Applies to
AddConnectionString(IDistributedApplicationBuilder, String, Action<ReferenceExpressionBuilder>)
Adds a connection string resource to the distributed application with the specified expression.
public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ConnectionStringResource> AddConnectionString(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, Action<Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder> connectionStringBuilder);static member AddConnectionString : Aspire.Hosting.IDistributedApplicationBuilder * string * Action<Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ConnectionStringResource><Extension()>
Public Function AddConnectionString (builder As IDistributedApplicationBuilder, name As String, connectionStringBuilder As Action(Of ReferenceExpressionBuilder)) As IResourceBuilder(Of ConnectionStringResource)Parameters
- builder
- IDistributedApplicationBuilder
Distributed application builder
- name
- String
The name of the resource.
- connectionStringBuilder
- Action<ReferenceExpressionBuilder>
The callback to configure the connection string expression.
Returns
An IResourceBuilder<T> instance.
Examples
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();
Remarks
This method also enables appending custom data to the connection string based on other resources that expose connection strings.