DockerComposeAspireDashboardResource Class

Definition

Namespace:: Aspire.Hosting.Docker

Assembly:: Aspire.Hosting.Docker.dll

Package:: Aspire.Hosting.Docker v9.4.0-preview.1.25378.8

Source:: DockerComposeAspireDashboardResource.cs

Source:: DockerComposeAspireDashboardResource.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 resource for the Aspire Dashboard. This resource is used to visualize telemetry data in the Aspire Hosting environment.

public class DockerComposeAspireDashboardResource : Aspire.Hosting.ApplicationModel.ContainerResource

type DockerComposeAspireDashboardResource = class
    inherit ContainerResource

Public Class DockerComposeAspireDashboardResource
Inherits ContainerResource

Inheritance: Object

Resource

ContainerResource
DockerComposeAspireDashboardResource

Constructors

DockerComposeAspireDashboardResource(String)

Represents a resource for the Aspire Dashboard. This resource is used to visualize telemetry data in the Aspire Hosting environment.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
Entrypoint	The container Entrypoint. (Inherited from ContainerResource)
Name	Gets the name of the resource. (Inherited from Resource)
OtlpGrpcEndpoint	Gets or sets the URL of the OTLP gRPC endpoint for telemetry data.
PrimaryEndpoint	Gets or sets the URL of the Aspire Dashboard.

Extension Methods

GetArgumentValuesAsync(IResourceWithArgs, DistributedApplicationOperation)	Get the arguments from the given resource.
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.
GetEndpoint(IResourceWithEndpoints, String)	Gets an endpoint reference for the specified endpoint name.
GetEndpoints(IResourceWithEndpoints)	Gets the endpoints for the specified resource.
GetEnvironmentVariableValuesAsync(IResourceWithEnvironment, DistributedApplicationOperation)	Get the environment variables from the given resource.
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`
IsExcludedFromPublish(IResource)	Gets a value indicating whether the resource is excluded from being published.
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.
IsEmulator(IResource)	Determines whether the specified resource is an emulator resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to