Definition
A C# resource-builder extension method that attaches typed annotation metadata to a resource.
- Also known as
- annotation attachment
WithAnnotation is part of the .NET resource-builder API. It lets integration authors attach typed metadata that other parts of Aspire can inspect and act on.
The TypeScript SDK does not expose a general withAnnotation counterpart. Use supported TypeScript configuration methods, such as endpoint and environment methods, which attach the necessary metadata internally.
An annotation needs a consumer to give it meaning. Attaching arbitrary metadata by itself does not create a new orchestration behavior.
Practical example
A C# hosting integration attaches a custom annotation, then its orchestration or publishing logic reads that metadata.
Aspire