DockerfileBuildAnnotation

Docs / Reference / Search C# APIs / Aspire.Hosting / DockerfileBuildAnnotation

DockerfileBuildAnnotation

Docs Reference Search C# APIs Aspire.Hosting DockerfileBuildAnnotation

Class net10.0

📦 Aspire.Hosting v13.1.2

Represents an annotation for customizing a Dockerfile build.

namespace Aspire.Hosting.ApplicationModel;

public class DockerfileBuildAnnotation
    : Aspire.Hosting.ApplicationModel.IResourceAnnotation
{
    // ...
}

IResourceAnnotation

Implements

• IResourceAnnotation

Source

Search members of DockerfileBuildAnnotation...

constructor method property

11 members Clear filters

Constructors1

DockerfileBuildAnnotation(string, string, string?)

Represents an annotation for customizing a Dockerfile build.

View all constructors

Properties9

BuildArgumentsget

Dictionary<string, object?>

Gets the arguments to pass to the build.

BuildSecretsget

Dictionary<string, object>

Gets the secrets to pass to the build.

ContextPathget

string

Gets the path to the context directory for the build.

DockerfileFactoryget; init

Func<DockerfileFactoryContext, Task<string>>

Gets or sets the factory function that generates Dockerfile content dynamically. When set, this factory will be invoked to generate the Dockerfile content at build time, and the content will be written to a generated file path.

DockerfilePathget

string

Gets the path to the Dockerfile to use for the build.

HasEntrypointget; set

bool

Gets or sets a value indicating whether an entry point is defined in the Dockerfile.

ImageNameget; set

string?

Gets or sets the image name for the generated container image. When set, this will be used as the container image name instead of the value from ContainerImageAnnotation.

ImageTagget; set

string?

Gets or sets the image tag for the generated container image. When set, this will be used as the container image tag instead of the value from ContainerImageAnnotation.

Stageget

string?

Gets the name of the build stage to use for the build.

View all properties

Methods1

MaterializeDockerfileAsync(DockerfileFactoryContext, CancellationToken)

Task

Materializes the Dockerfile from the factory if it hasn't been materialized yet. This method is thread-safe and ensures the Dockerfile is only written once.

View all methods