VolumeMountBindingAnnotation Constructors

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

ClassConstructors1 member

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

Constructor(string)

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

public sealed class VolumeMountBindingAnnotation
{
    public VolumeMountBindingAnnotation(
        string volumeName)
    {
        // ...
    }
}

VolumeMountBindingAnnotation.cs#L41-L46

Parameters

volumeNamestring

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.