DockerComposeEnvironmentResource

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

DockerComposeEnvironmentResource

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

Classnet10.0

📦 Aspire.Hosting.Docker v13.6.0

Represents a Docker Compose environment resource that can host application resources.

namespace Aspire.Hosting.Docker;

public class DockerComposeEnvironmentResource
    : Aspire.Hosting.ApplicationModel.Resource,
      Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource,
      Aspire.Hosting.ApplicationModel.IComputeEnvironmentWithVolumeMounts,
      Aspire.Hosting.ApplicationModel.IResource
{
    // ...
}

ResourceIComputeEnvironmentResourceIComputeEnvironmentWithVolumeMountsIResource

Inherits

Resource→DockerComposeEnvironmentResource

Implements

• IComputeEnvironmentResource
• IComputeEnvironmentWithVolumeMounts
• IResource

Source

ATS export

Type ID: Aspire.Hosting.Docker/DockerComposeEnvironmentResource

Public instance properties are exported as ATS capabilities.

Public instance methods are exported as ATS capabilities.

Remarks

Initializes a new instance of the DockerComposeEnvironmentResource class.

Constructors1

DockerComposeEnvironmentResource(string)

View all constructors

Properties2

DashboardEnabledget; set

bool

Determines whether to include an Aspire dashboard for telemetry visualization in this environment.

DefaultNetworkNameget; set

string?

The name of an existing network to be used.

View all properties

Methods1

GetHostAddressExpression(EndpointReference)experimental

ReferenceExpression

Gets a ApplicationModel.ReferenceExpression representing the host address or host name for the specified ApplicationModel.EndpointReference.

View all methods