DockerComposeEnvironmentResource Class

Reference

Definition

Namespace:: Aspire.Hosting.Docker

Assembly:: Aspire.Hosting.Docker.dll

Package:: Aspire.Hosting.Docker v9.3.0-preview.1.25265.20

Source:: DockerComposeEnvironmentResource.cs

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.IComputeEnvironmentResource

type DockerComposeEnvironmentResource = class
    inherit Resource
    interface IComputeEnvironmentResource
    interface IResource

Public Class DockerComposeEnvironmentResource
Inherits Resource
Implements IComputeEnvironmentResource

Inheritance: Object

Resource
DockerComposeEnvironmentResource

Implements: IComputeEnvironmentResource IResource

Remarks

Initializes a new instance of the DockerComposeEnvironmentResource class.

Constructors

DockerComposeEnvironmentResource(String)

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
BuildContainerImages	Determines whether to build container images for the resources 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)

Extension Methods

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 `1` if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)	Gets whether `resource` or its ancestors have an annotation of type `T`
HasAnnotationOfType<T>(IResource)	Gets whether `resource` has an annotation of type `T`
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, String, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
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, 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.
IsContainer(IResource)	Determines whether the specified resource is a container resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to

Share via