ConnectionStringReference Properties

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Hosting
5. /ConnectionStringReference
6. /Properties

ClassProperties4 members

Represents a reference to a connection string.

ConnectionStringExpressionReferenceExpression

Gets the expression for the referenced connection-string value.

public ReferenceExpression ConnectionStringExpression { get; }

ConnectionStringReference.cs#L53

Remarks

Uses the resource's current connection-string expression unless the reference selects another connection-string value, such as an HTTP connection on a resource with multiple protocols.

Experimental — ASPIRECONNECTIONSTRINGS001

EnvironmentVariableNamesnullableConnectionStringEnvironmentVariableNames?

Gets the logical and physical environment-variable names when this reference represents a generated connection-string injection, or null for a standalone value reference.

public ConnectionStringEnvironmentVariableNames? EnvironmentVariableNames { get; }

ConnectionStringReference.cs#L44

Optionalbool

A flag indicating whether the connection string is optional.

public bool Optional { get; }

ConnectionStringReference.cs#L37

ResourceIResourceWithConnectionString

The resource that the connection string is referencing.

public IResourceWithConnectionString Resource { get; }

ConnectionStringReference.cs#L32