VolumeMountBindingAnnotation

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Hosting
5. /VolumeMountBindingAnnotation

Classsealednet10.0

📦 Aspire.Hosting v13.6.0

Describes how a named volume binds to a resource across the inner and outer loop.

namespace Aspire.Hosting.ApplicationModel;

public sealed class VolumeMountBindingAnnotation
    : Aspire.Hosting.ApplicationModel.IResourceAnnotation
{
    // ...
}

IResourceAnnotation

Implements

• IResourceAnnotation

Source

Search members of VolumeMountBindingAnnotation...

constructormethodproperty

6 members

Clear filtersReset all

Remarks

This annotation is the extensibility point compute environments use to participate in the portable volume path convention. It carries two independent facets, either of which may be absent:

• VolumeMountBindingAnnotation.EnvironmentVariableName records that the workload reads the effective storage path from an environment variable. The variable itself is written by an EnvironmentCallbackAnnotation whose closure captures the name, which makes the intent invisible to anything inspecting the model. Restating it here lets a compute environment tell whether a host process materializes a local backing store for the volume, without having to observe the callback running.
• VolumeMountBindingAnnotation.RunModeHostPathResolver lets a compute environment supply the local directory that backs the volume in run mode. Without it, host processes fall back to a workload-scoped directory under IAspireStore.

The two facets are produced by different parties at different times — the AppHost author opts into the environment variable, while the compute environment supplies the local path — so a resource can carry several of these annotations for the same VolumeMountBindingAnnotation.VolumeName. A binding resolves through its own VolumeMountBindingAnnotation.RunModeHostPathResolver when it has one, and otherwise takes the last sibling that does. VolumeMountBindingAnnotation.VolumeName alone is not a unique key, because separate compute environments can each declare a volume under the same name.

Constructors1

VolumeMountBindingAnnotation(string)

Describes how a named volume binds to a resource across the inner and outer loop.

View all constructors

Properties4

EnvironmentVariableNameget; init

string?

Gets the environment variable that receives the effective storage path, or null when this binding only supplies a run-mode path.

MountPathget; init

string?

Gets the path the volume is mounted at once deployed, or null when this binding only supplies a run-mode path for a mount declared elsewhere.

RunModeHostPathResolverget; init

Func<EnvironmentCallbackContext, string>

Gets a callback that returns the local host directory backing the volume in run mode, or null to use the default workload-scoped directory under IAspireStore.

VolumeNameget

string

Gets the name of the volume this binding applies to.

View all properties

Methods1

ResolvePath(EnvironmentCallbackContext)

string

Resolves the storage path the workload should use for the current execution mode.

View all methods