Aspire.Hosting Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| AzureAIFoundryExtensions |
Provides extension methods for adding the Azure AI Foundry resources to the application model. |
| AzureAppConfigurationExtensions |
Provides extension methods for adding the Azure AppConfiguration resources to the application model. |
| AzureApplicationInsightsExtensions |
Provides extension methods for adding the Azure ApplicationInsights resources to the application model. |
| AzureAppServiceComputeResourceExtensions |
Provides extension methods for publishing compute resources as Azure App Service websites. |
| AzureAppServiceEnvironmentExtensions |
Extensions for adding Azure App Service Environment resources to a distributed application builder. |
| AzureBicepResourceExtensions |
Extension methods for adding Azure Bicep resources to the application model. |
| AzureConstructResource |
An Aspire resource that supports use of Azure Provisioning APIs to create Azure resources. |
| AzureConstructResourceExtensions |
Extensions for working with AzureConstructResource and related types. |
| AzureContainerAppContainerExtensions |
Provides extension methods for publishing container resources as container apps in Azure. |
| AzureContainerAppExecutableExtensions |
Provides extension methods for publishing executable resources (with docker files) as container apps in Azure. |
| AzureContainerAppExtensions |
Provides extension methods for customizing Azure Container App definitions for projects. |
| AzureContainerAppProjectExtensions |
Provides extension methods for publishing project resources as container apps in Azure. |
| AzureContainerRegistryExtensions |
Provides extension methods for adding Azure Container Registry resources to the application model. |
| AzureCosmosDBResource |
A resource that represents an Azure Cosmos DB. |
| AzureCosmosExtensions |
Extension methods for adding Azure Cosmos DB resources to the application model. |
| AzureEventHubsExtensions |
Provides extension methods for adding the Azure Event Hubs resources to the application model. |
| AzureFunctionsProjectResourceExtensions |
Extension methods for AzureFunctionsProjectResource. |
| AzureKeyVaultResourceExtensions |
Provides extension methods for adding the Azure Key Vault resources to the application model. |
| AzureLogAnalyticsWorkspaceExtensions |
Provides extension methods for adding the Azure Log Analytics Workspace resources to the application model. |
| AzureOpenAIExtensions |
Provides extension methods for adding the Azure OpenAI resources to the application model. |
| AzurePostgresExtensions |
Provides extension methods for adding the Azure PostgreSQL resources to the application model. |
| AzureProvisionerExtensions |
Provides extension methods for adding support for generating Azure resources dynamically during application startup. |
| AzureProvisioningResourceExtensions |
Extensions for working with AzureProvisioningResource and related types. |
| AzureRedisExtensions |
Provides extension methods for adding the Azure Redis resources to the application model. |
| AzureResourceExtensions |
Provides extension methods for adding Azure resources to the application model. |
| AzureSearchExtensions |
Provides extension methods for adding the Azure AI Search resources to the application model. |
| AzureServiceBusExtensions |
Provides extension methods for adding the Azure Service Bus resources to the application model. |
| AzureSignalRExtensions |
Provides extension methods for adding the Azure SignalR resources to the application model. |
| AzureSqlExtensions |
Provides extension methods for adding the Azure SQL resources to the application model. |
| AzureStorageExtensions |
Extension methods for adding Azure Storage resources to an application model. |
| AzureWebPubSubExtensions |
Provides extension methods for adding the Azure Web PubSub resources to the application model. |
| CloudFormationExtensions |
Extension methods for adding AWS CloudFormation as a provisioning resource. |
| ConnectionStringBuilderExtensions |
Provides extension methods for adding connection string resources to an application. |
| ConnectionStringResource |
Adds a connection string to the distributed application a resource with the specified expression. |
| ContainerAppExtensions |
Provides extension methods for customizing Azure Container App resource. |
| ContainerResourceBuilderExtensions |
Provides extension methods for IDistributedApplicationBuilder to add container resources to the application. |
| ContainerResourceExtensions |
Provides extension methods for working with container resources in a distributed application model. |
| CustomResourceExtensions |
Extension methods for applying dashboard annotations to resources. |
| DistributedApplication |
Represents a distributed application that implements the IHost and IAsyncDisposable interfaces. |
| DistributedApplicationBuilder |
A builder for creating instances of DistributedApplication. |
| DistributedApplicationBuilderExtensions |
Extensions for IDistributedApplicationBuilder. |
| DistributedApplicationException |
Represents an exception that is thrown when a distributed application error occurs. |
| DistributedApplicationExecutionContext |
Exposes the global contextual information for this invocation of the AppHost. |
| DistributedApplicationExecutionContextOptions |
Configuration options and references that need to be exposed to the DistributedApplicationExecutionContext. |
| DistributedApplicationOptions |
Options for configuring the behavior of CreateBuilder(DistributedApplicationOptions). |
| DockerComposeAspireDashboardResourceBuilderExtensions |
Provides extension methods for creating Aspire Dashboard resources in the application model. |
| DockerComposeEnvironmentExtensions |
Provides extension methods for adding Docker Compose environment resources to the application model. |
| DockerComposeServiceExtensions |
Provides extension methods for customizing Docker Compose service resources. |
| ElasticsearchBuilderExtensions |
Provides extension methods for adding Elasticsearch resources to the application model. |
| EmulatorResourceExtensions |
Extension methods for managing emulator resources. |
| EventingExtensions |
Provides extension methods for subscribing to IDistributedApplicationResourceEvent events on resources. |
| ExecutableResourceBuilderExtensions |
Provides extension methods for adding executable resources to the IDistributedApplicationBuilder application model. |
| ExecutableResourceExtensions |
Provides extension methods for working with ExecutableResource objects. |
| ExistingAzureResourceExtensions |
Extension methods for interacting with resources that are not managed by Aspire's provisioning or container management layer. |
| ExternalServiceBuilderExtensions |
Provides extension methods for adding external services to an application. |
| ExternalServiceResource |
Represents an external service resource with service discovery capabilities. |
| GarnetBuilderExtensions |
Provides extension methods for adding Garnet resources to the application model. |
| GitHubModelsExtensions |
Provides extension methods for adding GitHub Models resources to the application model. |
| IDistributedApplicationBuilderExtensions |
Extensions to IDistributedApplicationBuilder related to Dapr. |
| IDistributedApplicationResourceBuilderExtensions |
Extensions to IResourceBuilder<T> related to Dapr. |
| InputsDialogInteractionOptions |
Options for configuring an inputs dialog interaction. |
| InputsDialogValidationContext |
Represents the context for validating inputs in an inputs dialog interaction. |
| InteractionInput |
Represents an input for an interaction. |
| InteractionOptions |
Optional configuration for interactions added with Aspire.Hosting.InteractionService. |
| InteractionResult |
Provides a set of static methods for the InteractionResult<T>. |
| InteractionResult<T> |
Represents the result of an interaction. |
| KafkaBuilderExtensions |
Provides extension methods for adding Kafka resources to the application model. |
| KafkaServerResource |
A resource that represents a Kafka broker. |
| KafkaUIContainerResource |
A resource that represents a Kafka UI container. |
| KeycloakResourceBuilderExtensions |
Provides extension methods for adding Keycloak resources to an IDistributedApplicationBuilder. |
| KubernetesEnvironmentExtensions |
Provides extension methods for adding Kubernetes environment resources to the application model. |
| KubernetesServiceExtensions |
Provides extension methods for customizing Kubernetes service resources. |
| LaunchProfile |
Represents a launch profile for a ProjectResource. |
| LaunchSettings |
Represents the launch settings for a ProjectResource. |
| MessageBoxInteractionOptions |
Options for configuring a message box interaction. |
| MilvusBuilderExtensions |
Provides extension methods for adding Milvus resources to the application model. |
| MissingParameterValueException |
The exception that is thrown when a parameter resource cannot be initialized because its value is missing or cannot be resolved. |
| MongoDBBuilderExtensions |
Provides extension methods for adding MongoDB resources to an IDistributedApplicationBuilder. |
| MySqlBuilderExtensions |
Provides extension methods for adding MySQL resources to an IDistributedApplicationBuilder. |
| NatsBuilderExtensions |
Provides extension methods for adding NATS resources to the application model. |
| NodeAppHostingExtension |
Provides extension methods for adding Node applications to an IDistributedApplicationBuilder. |
| NodeAppResource |
A resource that represents a node application. |
| NotificationInteractionOptions |
Options for configuring a notification interaction. |
| OracleDatabaseBuilderExtensions |
Provides extension methods for adding Oracle Database resources to an IDistributedApplicationBuilder. |
| OrleansServiceClientExtensions |
Extension methods for OrleansServiceClient. |
| OrleansServiceExtensions |
Extensions to IDistributedApplicationBuilder related to Orleans. |
| OtlpConfigurationExtensions |
Provides extension methods for configuring OpenTelemetry in projects using environment variables. |
| ParameterResourceBuilderExtensions |
Provides extension methods for adding parameter resources to an application. |
| PostgresBuilderExtensions |
Provides extension methods for adding PostgreSQL resources to an IDistributedApplicationBuilder. |
| ProjectResourceBuilderExtensions |
Provides extension methods for IDistributedApplicationBuilder to add and configure project resources. |
| ProjectResourceOptions |
Various properties to modify the behavior of the project resource. |
| PythonAppResourceBuilderExtensions |
Provides extension methods for adding Python applications to an IDistributedApplicationBuilder. |
| PythonProjectResourceBuilderExtensions |
This class is retained only for compatibility. |
| QdrantBuilderExtensions |
Provides extension methods for adding Qdrant resources to the application model. |
| RabbitMQBuilderExtensions |
Provides extension methods for adding RabbitMQ resources to an IDistributedApplicationBuilder. |
| RedisBuilderExtensions |
Provides extension methods for adding Redis resources to the application model. |
| ResourceBuilderExtensions |
Provides extension methods for configuring resources with environment variables. |
| ResourceModuleConstruct |
An Azure Provisioning construct which represents the root Bicep module that is generated for an Azure construct resource. |
| SDKResourceExtensions |
Extension methods for configuring the AWS SDK for .NET |
| SeqBuilderExtensions |
Provides extension methods for adding Seq server resources to the application model. |
| SqlServerBuilderExtensions |
Provides extension methods for adding SQL Server resources to the application model. |
| ValkeyBuilderExtensions |
Provides extension methods for adding Valkey resources to the application model. |
| VolumeNameGenerator |
Utility class for generating volume names. |
| YarpConfigurationBuilderExtensions |
Collection of extensions methods for IYarpConfigurationBuilder |
| YarpResourceExtensions |
Provides extension methods for adding YARP resources to the application model. |
Interfaces
| IDistributedApplicationBuilder |
A builder for creating instances of DistributedApplication. |
| IInteractionService |
A service to interact with the current development environment. |
| IProjectMetadata |
Represents metadata about a project resource. |
| IResourceWithServiceDiscovery |
A resource that supports exporting service discovery information. |
| IYarpConfigurationBuilder |
Interface to build a configuration file for YARP |
Enums
| DistributedApplicationOperation |
Describes the context in which the AppHost is being executed. |
| InputType |
Specifies the type of input for an InteractionInput. |
| MessageIntent |
Specifies the intent or purpose of a message in an interaction. |