CapturedEnvironmentVariable

Docs / Reference / Search C# APIs / Aspire.Hosting.Docker / CapturedEnvironmentVariable

CapturedEnvironmentVariable

Docs Reference Search C# APIs Aspire.Hosting.Docker CapturedEnvironmentVariable

Class sealed net8.0

📦 Aspire.Hosting.Docker v13.3.0

Represents a captured environment variable that will be written to the .env file adjacent to the Docker Compose file.

namespace Aspire.Hosting.Docker;

public sealed class CapturedEnvironmentVariable
{
    // ...
}

Source

ATS export

Type ID: Aspire.Hosting.Docker/CapturedEnvironmentVariable

Search members of CapturedEnvironmentVariable...

constructor property

6 members Clear filters

Constructors1

CapturedEnvironmentVariable

View all constructors

Properties5

DefaultValueget; set

string?

Gets or sets the default value for the environment variable.

Descriptionget; set

string?

Gets or sets the description for the environment variable.

Nameget; initats ignored

string

Gets the name of the environment variable.

Resourceget; setats ignored

IResource?

Gets or sets the resource that this environment variable is associated with. This is useful when the source is an annotation on a resource, allowing you to identify which resource this environment variable is related to.

Sourceget; set

object?

Gets or sets the source object that originated this environment variable. This could be a ApplicationModel.ParameterResource, ApplicationModel.ContainerMountAnnotation, ApplicationModel.ContainerImageReference, or ApplicationModel.ContainerPortReference.

View all properties