DockerComposeEnvironmentResource Class
Definition
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.
Represents a Docker Compose environment resource that can host application resources.
public class DockerComposeEnvironmentResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IComputeEnvironmentResourcetype DockerComposeEnvironmentResource = class
inherit Resource
interface IComputeEnvironmentResource
interface IResourcePublic Class DockerComposeEnvironmentResource
Inherits Resource
Implements IComputeEnvironmentResource- Inheritance
- Implements
Remarks
Initializes a new instance of the DockerComposeEnvironmentResource class.
Constructors
| Name | Description |
|---|---|
| DockerComposeEnvironmentResource(String) | |
Properties
| Name | Description |
|---|---|
| Annotations |
Gets the annotations associated with the resource. (Inherited from Resource) |
| BuildContainerImages |
Determines whether to build container images for the resources in this environment. |
| DashboardEnabled |
Determines whether to include an Aspire dashboard for telemetry visualization in this environment. |
| DefaultContainerRegistry |
The container registry to use. |
| DefaultNetworkName |
The name of an existing network to be used. |
| Name |
Gets the name of the resource. (Inherited from Resource) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IComputeEnvironmentResource.GetHostAddressExpression(EndpointReference) |
Computes the host URL ReferenceExpression for the given EndpointReference. |
Extension Methods
| Name | Description |
|---|---|
| GetDeploymentTargetAnnotation(IResource, IComputeEnvironmentResource) |
Gets the deployment target for the specified resource, if any. Throws an exception if there are multiple compute environments and a compute environment is not explicitly specified. |
| GetReplicaCount(IResource) |
Gets the number of replicas for the specified resource. Defaults to |
| HasAnnotationIncludingAncestorsOfType<T>(IResource) |
Gets whether |
| HasAnnotationOfType<T>(IResource) |
Gets whether |
| IsContainer(IResource) |
Determines whether the specified resource is a container resource. |
| IsEmulator(IResource) |
Determines whether the specified resource is an emulator resource. |
| IsExcludedFromPublish(IResource) |
Gets a value indicating whether the resource is excluded from being published. |
| IsExisting(IResource) |
Determines if the resource is an existing resource. |
| ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, CancellationToken) |
Obsolete.
Processes argument values for the specified resource in the given execution context. |
| ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken) |
Processes argument values for the specified resource in the given execution context. |
| ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, CancellationToken) |
Obsolete.
Processes environment variable values for the specified resource within the given execution context. |
| ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken) |
Processes environment variable values for the specified resource within the given execution context. |
| RequiresImageBuild(IResource) |
Determines whether the specified resource requires image building. |
| RequiresImageBuildAndPush(IResource) |
Determines whether the specified resource requires image building and pushing. |
| ResolveEndpoints(IResource, IPortAllocator) |
Resolves endpoint port configuration for the specified resource. Computes target ports and exposed ports based on resource type, endpoint configuration, and whether the endpoint is considered a default HTTP endpoint. |
| TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>) |
Attempts to retrieve all annotations of the specified type from the given resource including from parents. |
| TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>) |
Attempts to retrieve all annotations of the specified type from the given resource. |
| TryGetContainerImageName(IResource, Boolean, String) |
Attempts to get the container image name from the given resource. |
| TryGetContainerImageName(IResource, String) |
Attempts to get the container image name from the given resource. |
| TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>) |
Attempts to get the container mounts for the specified resource. |
| TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>) |
Attempts to retrieve the endpoints for the given resource. |
| TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>) |
Attempts to get the environment variables from the given resource. |
| TryGetLastAnnotation<T>(IResource, T) |
Attempts to get the last annotation of the specified type from the resource. |
| TryGetUrls(IResource, IEnumerable<ResourceUrlAnnotation>) |
Attempts to retrieve the URLs for the given resource. |