Skip to content

Instantly share code, notes, and snippets.

@joperezr
Last active September 10, 2025 17:10
Show Gist options
  • Select an option

  • Save joperezr/24441b5b52897154c56937bce2bee6d9 to your computer and use it in GitHub Desktop.

Select an option

Save joperezr/24441b5b52897154c56937bce2bee6d9 to your computer and use it in GitHub Desktop.
Experimental APIs and Preview packages in Aspire

Experimental APIs in Aspire

Experimental APIs (by Diagnostic Code)

Diagnostic Code Package API Type Fully Qualified API Name Description
ASPIREPROXYENDPOINTS001 Aspire.Hosting Method Aspire.Hosting.ContainerResourceBuilderExtensions.WithEndpointProxySupport<T>(ApplicationModel.IResourceBuilder<T>, bool) Extension method for enabling proxy support on container resources
ASPIREINTERACTION001 Aspire.Hosting Interface Aspire.Hosting.IInteractionService Service for prompting user interactions during application lifecycle
ASPIREINTERACTION001 Aspire.Hosting Class Aspire.Hosting.InputsDialogInteractionOptions Options for input dialog interactions
ASPIREINTERACTION001 Aspire.Hosting Enum Aspire.Hosting.InputType Enumeration for different input types (Text, SecretText, Choice, Boolean, Number)
ASPIREINTERACTION001 Aspire.Hosting Class Aspire.Hosting.InteractionInput Represents an input field for user interactions
ASPIREINTERACTION001 Aspire.Hosting Class Aspire.Hosting.InteractionOptions Base options class for interactions
ASPIREINTERACTION001 Aspire.Hosting Class Aspire.Hosting.InteractionResult<T> Result wrapper for interaction responses
ASPIREINTERACTION001 Aspire.Hosting Class Aspire.Hosting.MessageBoxInteractionOptions Options for message box interactions
ASPIREINTERACTION001 Aspire.Hosting Enum Aspire.Hosting.MessageIntent Enumeration for message intent types
ASPIREINTERACTION001 Aspire.Hosting Class Aspire.Hosting.NotificationInteractionOptions Options for notification interactions
ASPIREINTERACTION001 Aspire.Hosting Method Aspire.Hosting.ParameterResourceBuilderExtensions.WithCustomInput(ApplicationModel.IResourceBuilder<ApplicationModel.ParameterResource>, System.Func<ApplicationModel.ParameterResource, InteractionInput>) Extension method for adding custom input to parameter resources
ASPIREINTERACTION001 Aspire.Hosting Class Aspire.Hosting.InputGeneratorAnnotation Annotation for generating custom inputs
ASPIRECOMPUTE001 Aspire.Hosting Method Aspire.Hosting.ResourceBuilderExtensions.WithComputeEnvironment<T>(ApplicationModel.IResourceBuilder<T>, ApplicationModel.IResourceBuilder<ApplicationModel.IComputeEnvironmentResource>) Extension method for associating compute environments with resources
ASPIRECOMPUTE001 Aspire.Hosting Class Aspire.Hosting.ContainerRegistryReferenceAnnotation Annotation for referencing container registries
ASPIRECOMPUTE001 Aspire.Hosting Property Aspire.Hosting.ApplicationModel.DistributedApplicationExecutionContext.ComputeEnvironment Property for accessing compute environment during deployment
ASPIRECOMPUTE001 Aspire.Hosting Property Aspire.Hosting.ApplicationModel.DistributedApplicationExecutionContext.ContainerRegistry Property for accessing container registry during deployment
ASPIRECOMPUTE001 Aspire.Hosting Interface Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource Interface for compute environment resources
ASPIRECOMPUTE001 Aspire.Hosting Interface Aspire.Hosting.ApplicationModel.IComputeResource Interface for compute resources
ASPIRECOMPUTE001 Aspire.Hosting Interface Aspire.Hosting.ApplicationModel.IContainerRegistry Interface for container registry providers
ASPIRECOMPUTE001 Aspire.Hosting.Azure Interface Aspire.Hosting.Azure.IAzureComputeEnvironmentResource Azure-specific compute environment resource interface
ASPIRECOMPUTE001 Aspire.Hosting.Azure Interface Aspire.Hosting.Azure.IAzureContainerRegistry Azure-specific container registry interface
ASPIRECOMPUTE001 Aspire.Hosting.Azure.OperationalInsights Class Aspire.Hosting.Azure.AzureLogAnalyticsWorkspaceReferenceAnnotation Annotation for referencing Azure Log Analytics workspaces
ASPIREPUBLISHERS001 Aspire.Hosting Method Aspire.Hosting.ResourceBuilderExtensions.WithPublishingCallback<T>(ApplicationModel.IResourceBuilder<T>, System.Func<ApplicationModel.PublishingContext, System.Threading.Tasks.Task>) Extension method for adding publishing callbacks to resources
ASPIREPUBLISHERS001 Aspire.Hosting Class Aspire.Hosting.DeployingCallbackAnnotation Annotation for deploying callbacks
ASPIREPUBLISHERS001 Aspire.Hosting Class Aspire.Hosting.DeployingContext Context object for deployment operations
ASPIREPUBLISHERS001 Aspire.Hosting Class Aspire.Hosting.PublishingCallbackAnnotation Annotation for publishing callbacks
ASPIREPUBLISHERS001 Aspire.Hosting Class Aspire.Hosting.PublishingContext Context object for publishing operations
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Enum Aspire.Hosting.Publishing.CompletionState Enumeration for completion states
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Class Aspire.Hosting.Publishing.ContainerBuildOptions Options for container building
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Enum Aspire.Hosting.Publishing.ContainerImageFormat Enumeration for container image formats
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Enum Aspire.Hosting.Publishing.ContainerTargetPlatform Enumeration for container target platforms
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Interface Aspire.Hosting.Publishing.IPublishingActivityReporter Interface for reporting publishing activities
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Interface Aspire.Hosting.Publishing.IPublishingStep Interface for publishing steps
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Interface Aspire.Hosting.Publishing.IPublishingTask Interface for publishing tasks
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Interface Aspire.Hosting.Publishing.IResourceContainerImageBuilder Interface for building container images from resources
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Class Aspire.Hosting.Publishing.PublishingExtensions Static class containing publishing extension methods
ASPIREPUBLISHERS001 Aspire.Hosting.Publishing Property Aspire.Hosting.Publishing.PublishingOptions.Deploy Property for controlling deployment behavior
ASPIREAZURE001 Aspire.Hosting Class Aspire.Hosting.AzureEnvironmentResource Resource representing an Azure environment
ASPIREAZURE001 Aspire.Hosting Method Aspire.Hosting.AzureEnvironmentResourceExtensions.AddAzureEnvironment(IDistributedApplicationBuilder) Extension method for adding Azure environment resources
ASPIREAZURE001 Aspire.Hosting Method Aspire.Hosting.AzureEnvironmentResourceExtensions.WithLocation(ApplicationModel.IResourceBuilder<AzureEnvironmentResource>, ApplicationModel.IResourceBuilder<ApplicationModel.ParameterResource>) Extension method for setting Azure environment location
ASPIREAZURE001 Aspire.Hosting Method Aspire.Hosting.AzureEnvironmentResourceExtensions.WithResourceGroup(ApplicationModel.IResourceBuilder<AzureEnvironmentResource>, ApplicationModel.IResourceBuilder<ApplicationModel.ParameterResource>) Extension method for setting Azure environment resource group
ASPIREAZURE001 Aspire.Hosting.Azure Class Aspire.Hosting.Azure.AzurePublishingContext Context object for Azure publishing operations
ASPIREACADOMAINS001 Aspire.Hosting Method Aspire.Hosting.ContainerAppExtensions.ConfigureCustomDomain(global::Azure.Provisioning.AppContainers.ContainerApp, ApplicationModel.IResourceBuilder<ApplicationModel.ParameterResource>, ApplicationModel.IResourceBuilder<ApplicationModel.ParameterResource>) Extension method for configuring custom domains on Azure Container Apps
ASPIRECOSMOSDB001 Aspire.Hosting Method Aspire.Hosting.AzureCosmosDBResourceExtensions.RunAsPreviewEmulator(ApplicationModel.IResourceBuilder<AzureCosmosDBResource>, System.Action<ApplicationModel.IResourceBuilder<Azure.AzureCosmosDBEmulatorResource>>?) Extension method for running CosmosDB as preview emulator
ASPIRECOSMOSDB001 Aspire.Hosting Method Aspire.Hosting.AzureCosmosDBEmulatorResourceExtensions.WithDataExplorer(ApplicationModel.IResourceBuilder<Azure.AzureCosmosDBEmulatorResource>, int?) Extension method for adding Data Explorer to CosmosDB emulator

Prerelease Packages (SuppressFinalPackageVersion=true)

The following packages are currently in prerelease and produce packages with prerelease suffixes:

Package ID Category Description
Aspire.Azure.AI.Inference Component Azure AI Inference client integration
Aspire.Azure.AI.OpenAI Component Azure OpenAI service integration
Aspire.Hosting.Azure.AIFoundry Hosting Azure AI Foundry hosting support
Aspire.Hosting.Azure.AppService Hosting Azure App Service hosting support
Aspire.Hosting.Azure.ContainerRegistry Hosting Azure Container Registry hosting support
Aspire.Hosting.Azure.Functions Hosting Azure Functions hosting support
Aspire.Hosting.Azure.Kusto Hosting Azure Kusto (Data Explorer) hosting support
Aspire.Hosting.Docker Hosting Docker container hosting support
Aspire.Hosting.GitHub.Models Hosting GitHub models hosting support
Aspire.Hosting.Keycloak Hosting Keycloak authentication server hosting support
Aspire.Hosting.Kubernetes Hosting Kubernetes hosting support
Aspire.Hosting.OpenAI Hosting OpenAI service hosting support
Aspire.Hosting.Yarp Hosting YARP reverse proxy hosting support
Aspire.Keycloak.Authentication Component Keycloak authentication client integration
Aspire.Microsoft.Extensions.Configuration.AzureAppConfiguration Component Azure App Configuration integration
Aspire.Milvus.Client Component Milvus vector database client integration
Aspire.OpenAI Component OpenAI service client integration

Summary

Experimental APIs

The experimental APIs in Aspire are organized into several functional areas:

  • ASPIREPROXYENDPOINTS001: Proxy endpoint support functionality
  • ASPIREINTERACTION001: User interaction system for prompting during application lifecycle
  • ASPIRECOMPUTE001: Compute environment and container registry abstractions
  • ASPIREPUBLISHERS001: Publishing and deployment pipeline infrastructure
  • ASPIREAZURE001: Azure environment resource management
  • ASPIREACADOMAINS001: Azure Container Apps custom domain configuration
  • ASPIRECOSMOSDB001: CosmosDB preview emulator features

Prerelease Packages

The prerelease packages include:

  • AI/ML integrations: Azure AI, OpenAI, Milvus vector database
  • Cloud hosting: Azure services (App Service, Functions, Container Registry, Kusto, AI Foundry)
  • Container orchestration: Docker, Kubernetes
  • Authentication: Keycloak
  • Proxy/networking: YARP
  • Configuration: Azure App Configuration
  • Development tools: GitHub Models

These experimental APIs and prerelease packages allow developers to access preview functionality while the features are still being refined before becoming stable parts of the public surface area.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment