ParameterResourceBuilderExtensions.AddConnectionString Method

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.dll

Package:: Aspire.Hosting v8.2.0

Package:: Aspire.Hosting v9.0.0

Source:: ParameterResourceBuilderExtensions.cs

Source:: ParameterResourceBuilderExtensions.cs

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.

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)

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

static member AddConnectionString : Aspire.Hosting.IDistributedApplicationBuilder * string * string -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.IResourceWithConnectionString>

<Extension()>
Public Function AddConnectionString (builder As IDistributedApplicationBuilder, name As String, Optional environmentVariableName As String = Nothing) As IResourceBuilder(Of IResourceWithConnectionString)

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

IResourceBuilder<IResourceWithConnectionString>

Resource builder for the parameter.

Exceptions

DistributedApplicationException

Applies to

Share via