IResourceWithConnectionString

Docs / Reference / Search C# APIs / Aspire.Hosting / IResourceWithConnectionString

IResourceWithConnectionString

Docs Reference Search C# APIs Aspire.Hosting IResourceWithConnectionString

Interface net8.0

📦 Aspire.Hosting v13.3.0

Represents a resource that has a connection string associated with it.

namespace Aspire.Hosting.ApplicationModel;

public interface IResourceWithConnectionString
    : Aspire.Hosting.ApplicationModel.IExpressionValue,
      Aspire.Hosting.ApplicationModel.IManifestExpressionProvider,
      Aspire.Hosting.ApplicationModel.IResource,
      Aspire.Hosting.ApplicationModel.IValueProvider,
      Aspire.Hosting.ApplicationModel.IValueWithReferences
{
    // ...
}

IExpressionValueIManifestExpressionProviderIResourceIValueProviderIValueWithReferences

Implements

• IExpressionValue
• IManifestExpressionProvider
• IResource
• IValueProvider
• IValueWithReferences

Source

Properties2

ConnectionStringEnvironmentVariablevirtualget

string?

The environment variable name to use for the connection string.

ConnectionStringExpressionabstractget

ReferenceExpression

Describes the connection string format string used for this resource.

View all properties

Methods2

GetConnectionPropertiesvirtual

IEnumerable<KeyValuePair<string, ReferenceExpression>>

Retrieves a collection of connection property name and value pairs associated with the current context.

GetConnectionStringAsync(CancellationToken)virtual

ValueTask<string?>

Gets the connection string associated with the resource.

View all methods