AspireExportAttribute

Class sealed net8.0

📦 Aspire.Hosting v13.3.0

Marks a method, type, or assembly-level type as an ATS (Aspire Type System) export.

namespace Aspire.Hosting;

public sealed class AspireExportAttribute
    : System.Attribute
{
    // ...
}

Attribute

10 members

Remarks

This attribute serves multiple purposes:

Capability exports (on methods): Marks a static method as an ATS capability. The capability ID is automatically derived as {AssemblyName}/{camelCaseMethodName}. For example: AddRedis in Aspire.Hosting.Redis becomes Aspire.Hosting.Redis/addRedis. Specify an explicit id only when disambiguation is needed (e.g., multiple overloads).
Type exports (on types): Marks a type as an ATS-exported type. The type ID is automatically derived as {AssemblyName}/{TypeName}. For example: RedisResource in Aspire.Hosting.Redis becomes Aspire.Hosting.Redis/RedisResource.
Context types (on types with ExposeProperties): When AspireExportAttribute.ExposeProperties is true, the type's properties are automatically exposed as get/set capabilities for use in callbacks.
External type exports (assembly-level): For types you don't own, use assembly-level with AspireExportAttribute.Type property to include them in the ATS type system.

Constructors3

AspireExportAttribute(string)

Initializes a new instance for a capability export (on methods) with an explicit capability ID.

AspireExportAttribute

Initializes a new instance for a type or method export.

AspireExportAttribute(Type)

Initializes a new instance for an assembly-level type export.

View all constructors

Properties7

Descriptionget; set

string?

Gets or sets a description of what this export does.

ExposeMethodsget; set

bool

Gets or sets whether to expose public instance methods of this type as ATS capabilities.

ExposePropertiesget; set

bool

Gets or sets whether to expose properties of this type as ATS capabilities.

Idget

string?

Gets the method name for capability exports.

MethodNameget; set

string?

Gets or sets the method name to use in generated polyglot SDKs.

RunSyncOnBackgroundThreadget; set

bool

Gets or sets whether synchronous exported methods should be invoked on a background thread by the ATS dispatcher.

Typeget; set

Type?

Gets or sets the CLR type for assembly-level type exports.

View all properties

Examples

// Capability export on a method - capability ID is auto-derived as Aspire.Hosting.Redis/addRedis
[AspireExport(Description = "Adds a Redis resource")]
public static IResourceBuilder<RedisResource> AddRedis(...) { }

// Capability export with explicit ID for disambiguation (e.g., multiple overloads)
[AspireExport("addRedisWithPort", Description = "Adds a Redis resource with a specific port")]
public static IResourceBuilder<RedisResource> AddRedis(..., int port) { }

// Type export - type ID derived as {AssemblyName}/{TypeName}
[AspireExport]
public class RedisResource : ContainerResource { }
// Type ID: Aspire.Hosting.Redis/RedisResource

// Context type with properties exposed as capabilities
[AspireExport(ExposeProperties = true)]
public class EnvironmentCallbackContext
{
    public Dictionary<string, object> EnvironmentVariables { get; }
    // Getter: Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.environmentVariables
    // Setter: Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.setEnvironmentVariables
}

// Member-level opt-in with ignore for specific members
[AspireExport(ExposeProperties = true)]
public class SomeContext
{
    public string Name { get; }  // Exposed
    [AspireExportIgnore]
    public ILogger Logger { get; }  // Not exposed
}

// Assembly-level export for types you don't own
[assembly: AspireExport(typeof(IConfiguration))]
// Type ID: Microsoft.Extensions.Configuration.Abstractions/IConfiguration