347 types and 1,707 members
Aspire.Hosting (64)
class
AspireDtoAttributesealed Marks a class as an ATS (Aspire Type System) Data Transfer Object. DTOs are serializable types used to pass structured data to capabilities.
class
AspireExportAttributesealed Marks a method, type, or assembly-level type as an ATS (Aspire Type System) export.
class
AspireExportIgnoreAttributesealed Excludes a property, method, or type from ATS export when the containing type uses
AspireExportAttribute.ExposeProperties or AspireExportAttribute.ExposeMethods. class
AspireUnionAttributesealed Specifies that a parameter or property accepts a union of multiple ATS types.
class
AspireValueAttributesealed Marks an immutable static field or property as an ATS-exported value.
class
ConnectionPropertiesExtensionsstatic Provides extension methods for adding connection properties to resources.
class
ConnectionStringBuilderExtensionsstatic Provides extension methods for adding connection string resources to an application.
class
ConnectionStringResourcesealed Adds a connection string to the distributed application a resource with the specified expression.
class
ContainerRegistryResourceBuilderExtensionsstatic Provides extension methods for adding container registry resources to the distributed application.
class
ContainerResourceBuilderExtensionsstatic Provides extension methods for
IDistributedApplicationBuilder to add container resources to the application. class
ContainerResourceExtensionsstatic Provides extension methods for working with container resources in a distributed application model.
class
CustomResourceExtensionsstatic Extension methods for applying dashboard annotations to resources.
class
DistributedApplicationats export Represents a distributed application that implements the
Hosting.IHost and IAsyncDisposable interfaces. class
DistributedApplicationBuilder A builder for creating instances of
DistributedApplication. class
DistributedApplicationBuilderExtensionsstatic Extensions for
IDistributedApplicationBuilder. class
DistributedApplicationEventingExtensionsstatic Provides extension methods for subscribing to
IDistributedApplicationEvent and IDistributedApplicationResourceEvent events. class
DistributedApplicationException Represents an exception that is thrown when a distributed application error occurs.
class
DistributedApplicationExecutionContextats export Exposes the global contextual information for this invocation of the AppHost.
class
DistributedApplicationExecutionContextOptionsats export Configuration options and references that need to be exposed to the
DistributedApplicationExecutionContext. enum
DistributedApplicationOperation Describes the context in which the AppHost is being executed.
class
DistributedApplicationOptionssealed Options for configuring the behavior of
DistributedApplication.CreateBuilder. class
DotnetToolResourceExtensionsstatic Provides extension methods for adding Dotnet Tool resources to the application model.
class
EmulatorResourceExtensionsstatic Extension methods for managing emulator resources.
class
ExecutableResourceBuilderExtensionsstatic Provides extension methods for adding executable resources to the
IDistributedApplicationBuilder application model. class
ExecutableResourceExtensionsstatic Provides extension methods for working with
ExecutableResource objects. class
ExternalServiceBuilderExtensionsstatic Provides extension methods for adding external services to an application.
class
ExternalServiceResourcesealed Represents an external service resource with service discovery capabilities.
interface
IDeveloperCertificateService Service that provides information about developer certificate trust capabilities.
interface
IDistributedApplicationBuilderats export A builder for creating instances of
DistributedApplication. interface
IFileSystemService Service for managing Aspire directories.
interface
IInteractionService A service to interact with the current development environment.
class
InputLoadOptionssealed Represents configuration options for dynamically loading input data.
class
InputsDialogInteractionOptions Options for configuring an inputs dialog interaction.
class
InputsDialogValidationContextsealedats export Represents the context for validating inputs in an inputs dialog interaction.
enum
InputType Specifies the type of input for an
InteractionInput. class
InteractionInputsealeddto Represents an input for an interaction.
class
InteractionInputCollectionsealedats export A collection of interaction inputs that supports both indexed and name-based access.
class
InteractionOptions Optional configuration for interactions added with
Hosting.InteractionService. class
InteractionResultstatic Provides a set of static methods for the
Hosting.InteractionResult`1. class
InteractionResult<T> Represents the result of an interaction.
interface
IProjectMetadata Represents metadata about a project resource.
interface
IResourceWithContainerFiles Represents a resource that contains files that can be copied to other resources.
interface
IResourceWithServiceDiscovery A resource that supports exporting service discovery information.
interface
ITempFileSystemService Service for managing temporary directories and files within Aspire.
interface
IUserSecretsManagerats export Defines an interface for managing user secrets with support for read and write operations.
class
LaunchProfilesealed Represents a launch profile for a
ProjectResource. class
LaunchSettingssealed Represents the launch settings for a
ProjectResource. class
LoadInputContextsealed The context for dynamic input loading. Used with
InputLoadOptions.LoadCallback. class
McpServerResourceBuilderExtensionsstatic Provides extension methods for configuring MCP (Model Context Protocol) server endpoints on resources.
class
MessageBoxInteractionOptions Options for configuring a message box interaction.
enum
MessageIntent Specifies the intent or purpose of a message in an interaction.
class
MissingParameterValueException The exception that is thrown when a parameter resource cannot be initialized because its value is missing or cannot be resolved.
class
NotificationInteractionOptions Options for configuring a notification interaction.
class
OtlpConfigurationExtensionsstatic Provides extension methods for configuring OpenTelemetry in projects using environment variables.
enum
OtlpProtocol Protocols available for OTLP exporters.
class
ParameterProcessorsealed Handles processing of parameter resources during application orchestration.
class
ParameterResourceBuilderExtensionsstatic Provides extension methods for adding parameter resources to an application.
class
ProjectResourceBuilderExtensionsstatic Provides extension methods for
IDistributedApplicationBuilder to add and configure project resources. class
ProjectResourceOptionsats export Various properties to modify the behavior of the project resource.
class
RequiredCommandResourceExtensionsstatic Provides extension methods for adding required command annotations to resources.
class
ResourceBuilderExtensionsstatic Provides extension methods for configuring resources with environment variables.
class
TempDirectoryabstract Represents a temporary directory that will be deleted when disposed.
class
TempFileabstract Represents a temporary file that will be deleted when disposed.
class
VolumeNameGeneratorstatic Utility class for generating volume names.
Aspire.Hosting.ApplicationModel (224)
class
AfterEndpointsAllocatedEventobsolete This event is published after all endpoints have been allocated.
class
AfterResourcesCreatedEventats export This event is published after all resources have been created.
class
AllocatedEndpoint Represents an endpoint allocated for a service instance.
class
AspireStoreExtensionsstatic Provides extension methods for
IDistributedApplicationBuilder to create an IAspireStore instance. class
BeforeResourceStartedEventats export This event is raised by orchestrators before they have started a new resource.
class
BeforeStartEventats export This event is published before the application starts.
class
CertificateAuthorityCollection Represents a collection of certificate authorities within the application model.
class
CertificateAuthorityCollectionAnnotationsealed An annotation that indicates a resource is referencing a certificate authority collection.
class
CertificateAuthorityCollectionResourceExtensionsstatic Provides extension methods for
CertificateAuthorityCollection. class
CertificateTrustConfigurationCallbackAnnotationsealed An annotation that indicates a resource wants to manage how custom certificate trust is configured.
class
CertificateTrustConfigurationCallbackAnnotationContextsealed Context provided to a
CertificateTrustConfigurationCallbackAnnotation callback. class
CertificateTrustExecutionConfigurationContextdto Context for configuring certificate trust configuration properties.
class
CertificateTrustExecutionConfigurationData Metadata about the resource certificate trust configuration.
enum
CertificateTrustScope Defines the scope of custom certificate authorities for a resource. The default scope for most resources is
CertificateTrustScope.Append, but some resources may choose to override this default behavior. class
CommandLineArgsCallbackAnnotation Represents an annotation that provides a callback to be executed with a list of command-line arguments when an executable resource is started.
class
CommandLineArgsCallbackContextsealedats export Represents a callback context for the list of command-line arguments associated with an executable resource.
class
CommandOptionsdto Optional configuration for resource commands added with
ResourceBuilderExtensions.WithCommand. class
CommandResultDatasealeddto Represents a value produced by a command.
enum
CommandResultFormat Specifies the format of a command result.
class
CommandResultsstatic A factory for
ExecuteCommandResult. class
ConnectionPropertyAnnotationsealed Annotation that creates a custom connection property value injected into environment variables when a resource is referenced using
WithReference(). class
ConnectionStringAvailableEventats export The
ConnectionStringAvailableEvent is raised when a connection string becomes available for a resource. class
ConnectionStringRedirectAnnotation Links to a resource that implements
IResourceWithConnectionString that can be used by the containing resource to acquire a connection string. class
ConnectionStringReference Represents a reference to a connection string.
class
ContainerBuildOptionsCallbackAnnotationsealed Annotation that provides a callback to configure container build options for a resource.
class
ContainerBuildOptionsCallbackContextsealed Context for configuring container build options via a callback.
class
ContainerCertificatePathsAnnotationsealed An annotation that allows overriding default certificate paths for container resources.
class
ContainerDirectorysealed Represents a directory in the container file system.
class
ContainerFilesealed Represents a standard file in the container file system.
class
ContainerFileBaseabstract Base class for files in the container file system (as compared to directories).
class
ContainerFilesDestinationAnnotationsealed Represents an annotation that specifies a source resource and destination path for copying container files.
class
ContainerFilesSourceAnnotationsealed Represents an annotation that associates a container file/directory with a resource.
class
ContainerFileSystemCallbackAnnotationsealed Represents a callback annotation that specifies files and folders that should be created or updated in a container.
class
ContainerFileSystemCallbackContextsealed Represents the context for a
ContainerFileSystemCallbackAnnotation callback. class
ContainerFileSystemCallbackHttpsCertificateContextsealed Represents the context for server authentication certificate files in a
ContainerFileSystemCallbackContext. class
ContainerFileSystemItemabstract Represents a base class for file system entries in a container.
class
ContainerImageAnnotationsealed Represents an annotation for a container image.
class
ContainerImagePullPolicyAnnotationsealed Annotation that controls the image pull policy for a container resource.
class
ContainerImagePushOptionssealedats export Represents options for pushing container images to a registry.
class
ContainerImagePushOptionsCallbackAnnotationsealed Represents an annotation that configures container image push options via a callback function.
class
ContainerImagePushOptionsCallbackContextsealedats export Provides context information for container image push options callbacks.
class
ContainerImageReference Represents the fully‑qualified container image reference that should be deployed.
enum
ContainerLifetime Lifetime modes for container resources.
class
ContainerLifetimeAnnotationsealed Annotation that controls the lifetime of a container resource.
class
ContainerMountAnnotationsealed Represents a mount annotation for a container resource.
enum
ContainerMountType Represents the type of a container mount.
class
ContainerNameAnnotationsealed Represents an annotation for a custom container name.
class
ContainerNetworkAliasAnnotationsealed Represents an annotation for a custom network alias for a container resource.
class
ContainerOpenSSLCertificateFilesealed Represents an OpenSSL public certificate in the container file system. Must be PEM encoded. An OpenSSL compatible symlink pointing to the destination file will be created in the same container folder as the certificate file named [subject hash].[n], where [n] is a sequence number that increases for each certificate in a target folder with the same subject hash.
class
ContainerPortReference Represents a TCP/UDP port that a container can expose.
class
ContainerRegistryReferenceAnnotation Annotation that indicates a resource is using a specific container registry.
class
ContainerRegistryResource Represents a general-purpose container registry resource that can be used to reference external container registries (e.g., Docker Hub, GitHub Container Registry, or private registries) in the application model.
class
ContainerResource A resource that represents a specified container.
class
ContainerRuntimeArgsCallbackAnnotationsealed Represents an additional argument to pass to the container runtime run command.
class
ContainerRuntimeArgsCallbackContextsealed Represents a callback context for the list of command-line arguments to be passed to the container runtime run command.
class
CSharpAppResource A resource that represents a specified C# project or file-based app.
class
CustomResourceKnownPropertiesstatic Known properties for resources that show up in the dashboard.
record
CustomResourceSnapshotsealed An immutable snapshot of the state of a resource.
class
CustomResourceSnapshotExtensionsstatic Provides extension methods for creating updated
CustomResourceSnapshot values. class
DefaultLaunchProfileAnnotationsealed An annotation that specifies the default launch profile for a resource.
class
DeploymentTargetAnnotationsealed Represents an annotation for a deployment target.
class
DisableForwardedHeadersAnnotationsealed Represents an annotation that disables enabling forwarded headers on ASP.NET Core projects on publish.
class
DistributedApplicationModelats export Represents a distributed application.
class
DistributedApplicationModelExtensionsstatic Provides extension methods on the
DistributedApplicationModel class. class
DockerBuildArgsealedobsolete Represents a name/value pair, used to satisfy the
docker builder --build-arg <NAME>[=<VALUE>] command switch. For more information, see https://docs.docker.com/reference/cli/docker/image/build/#build-arg. class
DockerfileBaseImageAnnotation Represents an annotation for specifying custom base images in generated Dockerfiles.
class
DockerfileBuildAnnotation Represents an annotation for customizing a Dockerfile build.
class
DockerfileBuilderCallbackAnnotation Represents an annotation for providing callbacks to programmatically modify Dockerfile builds.
class
DockerfileBuilderCallbackContextats export Provides context information for Dockerfile build callbacks.
class
DockerfileFactoryContextsealedats export Provides context for Dockerfile factory functions.
class
DotnetToolAnnotation Represents an annotation for dotnet tool resources.
class
DotnetToolResource A resource that represents a specified dotnet tool.
class
EmulatorResourceAnnotationsealed Represents an annotation for an emulator resource that should be ignored by provisioners.
class
EndpointAnnotationsealed Represents an endpoint annotation that describes how a service should be bound to a network.
enum
EndpointBindingMode Specifies how an endpoint is bound to network addresses.
class
EndpointHostHelpersstatic Provides helper methods for validating localhost addresses.
class
EndpointNameAttributesealed Signifies that a parameter represents an endpoint name.
Decorate String parameters representing endpoint names with this attribute, e.g.: public static IResourceBuilder<TResource> WithCustomEndpoint<TResource>( this IResourceBuilder<TResource> builder, [EndpointName] string name)
class
EndpointProbeAnnotationsealed Represents an annotation that specifies the HTTP probes (health, readiness, liveness, etc.) of a resource.
enum
EndpointProperty Represents the properties of an endpoint that can be referenced.
class
EndpointReferencesealedats export Represents an endpoint reference for a resource with endpoints.
class
EndpointReferenceAnnotationsealed An annotation that represents a reference from one resource to the endpoints of another resource.
class
EndpointReferenceExpressionats export Represents a property expression for an endpoint reference.
class
EnvironmentCallbackAnnotation Represents an annotation that provides a callback to modify the environment variables of an application.
class
EnvironmentCallbackContextats export Represents a callback context for environment variables associated with a publisher.
record
EnvironmentVariableSnapshotsealed A snapshot of an environment variable.
class
ExcludeLaunchProfileAnnotationsealed Represents an annotation that indicates that launch settings should not be used.
class
ExecutableAnnotationsealed Represents an annotation for a container image.
class
ExecutableResource A resource that represents a specified executable process.
class
ExecuteCommandContextsealedats export Context for
ResourceCommandAnnotation.ExecuteCommand. class
ExecuteCommandResultsealeddto The result of executing a command. Returned from
ResourceCommandAnnotation.ExecuteCommand. class
ExecutionConfigurationBuildersealed Provides a builder for constructing an
IExecutionConfigurationResult for a specific resource in the distributed application model. This resolves command line arguments and environment variables and potentially additional metadata through registered gatherers. class
ExecutionConfigurationBuilderExtensionsstatic Provides extension methods for
IExecutionConfigurationBuilder. class
ExecutionConfigurationResultExtensionsstatic Extension methods for
IExecutionConfigurationResult. class
ExplicitStartupAnnotationsealed Represents an annotation for instructing the resource not to be started with the app host.
struct
ExpressionInterpolatedStringHandler Represents a handler for interpolated strings that contain expressions. Those expressions will either be literal strings or instances of types that implement both
IValueProvider and IManifestExpressionProvider. class
GenerateParameterDefaultsealeddto Represents that a default value should be generated.
class
HealthCheckAnnotation An annotation which tracks the name of the health check used to detect to health of a resource.
record
HealthReportSnapshotsealed A report produced by a health check about a resource.
record
HostUrl Represents a URL on the host machine. When referenced in a container resource, localhost will be replaced with the configured container host name.
class
HttpCommandOptions Optional configuration for resource HTTP commands added with
ResourceBuilderExtensions.WithHttpCommand. class
HttpCommandRequestContextsealed Context passed to callback to configure
Http.HttpRequestMessage when using ResourceBuilderExtensions.WithHttpCommand or ResourceBuilderExtensions.WithHttpCommand. class
HttpCommandResultContextsealed Context passed to callback to configure
ExecuteCommandResult when using ResourceBuilderExtensions.WithHttpCommand or ResourceBuilderExtensions.WithHttpCommand. enum
HttpCommandResultMode Specifies how an HTTP command should surface the HTTP response body as command result data.
class
HttpsCertificateAnnotationsealed An annotation that associates an HTTPS/TLS server certificate with a resource.
class
HttpsCertificateConfigurationCallbackAnnotationsealed An annotation that indicates a resource wants to manage how it needs to be configured to use a specific TLS certificate pair.
class
HttpsCertificateConfigurationCallbackAnnotationContextsealed Context provided to a
HttpsCertificateConfigurationCallbackAnnotation callback. class
HttpsCertificateExecutionConfigurationContextdto Configuration context for server authentication certificate configuration.
class
HttpsCertificateExecutionConfigurationData Metadata for HTTPS/TLS server certificate configuration.
class
HttpsEndpointUpdateCallbackContextsealed Context provided to the callback of
ResourceBuilderExtensions.SubscribeHttpsEndpointsUpdate when an HTTPS certificate is determined to be available for the resource. interface
IAspireStore Represents a store for managing files in the Aspire hosting environment that can be reused across runs.
interface
IComputeEnvironmentResource Represents a compute environment resource.
interface
IComputeResource Represents a compute resource.
interface
IContainerFilesDestinationResource Represents a resource that can consume and copy files from resources that implement
IResourceWithContainerFiles. interface
IContainerRegistry Represents container registry information for deployment targets.
enum
IconVariant The icon variant.
interface
IExecutionConfigurationBuilder Builder for gathering and resolving the execution configuration (arguments and environment variables) for a specific resource.
interface
IExecutionConfigurationData Additional data associated with a resource's execution configuration. This allows gatherers to provide additional data required to properly configure or run the resource.
interface
IExecutionConfigurationGatherer Gathers resource configurations (arguments and environment variables) and optionally applies additional metadata to the resource.
interface
IExecutionConfigurationGathererContext Resource configuration gatherer context.
interface
IExecutionConfigurationResult Configuration (arguments and environment variables) to apply to a specific resource.
interface
IExpressionValueats export Represents a value that provides both a runtime value and a manifest expression.
enum
ImagePullPolicy Image pull policies for container resources.
interface
IManifestExpressionProvider An interface that allows an object to express how it should be represented in a manifest.
interface
IModelNameParameter Signifies that a parameter represents a model name.
class
InitializeResourceEventats export This event is raised by orchestrators to signal to resources that they should initialize themselves.
class
InputGeneratorAnnotation Annotation for customizing the input generation for a parameter.
interface
IPortAllocator Provides port allocation functionality for resources.
interface
IRequiredCommandValidator A service that validates required commands/executables are available on the local machine.
interface
IResource Represents a resource that can be hosted by an application.
interface
IResourceAnnotation Represents an annotation for a resource.
interface
IResourceBuilder<T> Defines a builder for creating resources of type
T. interface
IResourceCollection Represents a collection of resources.
interface
IResourceWithArgs Represents a resource that is associated with commandline arguments.
interface
IResourceWithConnectionString Represents a resource that has a connection string associated with it.
interface
IResourceWithCustomWithReference<TSelf> Defines custom
WithReference dispatch behavior for a resource type. interface
IResourceWithEndpoints Represents a resource that has endpoints associated with it.
interface
IResourceWithEnvironment Represents a resource that is associated with an environment.
interface
IResourceWithoutLifetime Represents a resource that does not have a lifetime. Reserved for resources that are just holders of data or references to other resources.
interface
IResourceWithParameters Represents a resource that has parameters.
interface
IResourceWithParent Represents a resource that has a parent resource.
interface
IResourceWithParent<T> Represents a resource that has a parent resource of type
T. interface
IResourceWithProbes Represents a resource that has probes associated with it.
interface
IResourceWithWaitSupport Represents a resource that can wait for other resources to be running, health, and/or completed.
interface
IValueProvider An interface that allows the value to be provided for an environment variable.
interface
IValueWithReferences An interface that allows the value to list its references.
class
KnownHostNamesstatic Provides known host names for use within the Aspire application model API.
class
KnownNetworkIdentifiersstatic Provides known network identifiers for use within the Aspire application model API.
class
KnownResourceCommandsstatic Provides constants for well-known resource command names.
class
KnownResourceStatesstatic The set of well known resource states.
class
KnownResourceStateStylesstatic The set of well known resource states.
class
LaunchProfileAnnotationsealed Represents an annotation that specifies the launch profile name for a resource.
enum
Lifetime Lifetime modes for resources that can outlive the app host process.
struct
LogLinereadonly Represents a console log line.
struct
LogSubscriberreadonly Represents a log subscriber for a resource.
class
ManifestPublishingCallbackAnnotation Represents an annotation that provides a callback to be executed during manifest publishing.
class
McpServerEndpointAnnotationsealed Represents an annotation that identifies an endpoint on a resource that hosts a Model Context Protocol (MCP) server.
class
NameValidationPolicyAnnotationsealed Represents an annotation that customizes the name validation rules applied to a resource when it is added to the application model.
record
NetworkEndpointSnapshot Represents an AllocatedEndpoint snapshot associated with a specific network.
class
NetworkEndpointSnapshotList Holds a list of
NetworkEndpointSnapshot for an Endpoint, providing thread-safe enumeration and addition. record
NetworkIdentifier A network identifier used to specify the network context for resources within an Aspire application model.
class
OtlpExporterAnnotation An annotation which indicates that a resource has OTLP exporter configured.
class
ParameterDefaultabstract Represents how a default value should be retrieved.
class
ParameterResource Represents a parameter resource.
class
PersistenceAnnotationsealed Annotation that controls the persistence behavior of a resource.
enum
PersistenceMode Persistence modes for resources that support lifetime configuration.
class
PortAllocatorsealed Allocates and manages a range of ports for use in an application context.
class
ProbeAnnotationabstract Represents an annotation that specifies the probes (health, readiness, liveness, etc.) of a resource.
enum
ProbeType Enum representing the type of probe.
class
ProcessCommandOptions Optional configuration for resource process commands added with
ResourceBuilderExtensions.WithProcessCommand. class
ProcessCommandResultContextsealed Context passed to callback to configure
ExecuteCommandResult when using ResourceBuilderExtensions.WithProcessCommand. class
ProcessCommandSpecsealed Describes a local process that is started when a process-backed resource command executes.
class
ProjectResource A resource that represents a specified .NET project.
class
ProjectResourceExtensionsstatic Provides extension methods for
DistributedApplicationModel to work with ProjectResource instances. class
ProxySupportAnnotationsealed Proxy support annotation for a resource, used to disable all endpoint proxies for a resource if desired
class
ReferenceEnvironmentInjectionAnnotationsealed Annotation that specifies which connection and endpoint information should be injected into environment variables when a resource is referenced using
WithReference(). enum
ReferenceEnvironmentInjectionFlags Specifies which connection or endpoint information should be injected into environment variables when
WithReference() is invoked. class
ReferenceExpressionats export Represents an expression that might be made up of multiple resource properties. For example, a connection string might be made up of a host, port, and password from different endpoints.
class
ReferenceExpressionBuilderats export A builder for creating
ReferenceExpression instances. struct
ReferenceExpressionBuilderInterpolatedStringHandler Represents a handler for interpolated strings that contain expressions. Those expressions will either be literal strings or instances of types that implement both
IValueProvider and IManifestExpressionProvider. class
RegistryTargetAnnotationsealed Annotation that indicates a resource should use a specific container registry as its default target.
record
RelationshipSnapshotsealed A snapshot of a relationship.
class
ReplicaAnnotationsealed Represents an annotation that specifies the number of replicas for a resource.
class
RequiredCommandAnnotation An annotation which declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start.
class
RequiredCommandValidationContextsealed Provides context for validating a required command.
class
RequiredCommandValidationResultsealed Represents the result of validating a required command.
class
ResolvedEndpointsealed Represents a resolved endpoint with computed target and exposed ports.
struct
ResolvedPortreadonly Represents a resolved port with information about whether it was allocated or explicitly specified.
class
Resourceabstract Represents an abstract resource that can be used by an application, that implements
IResource. class
ResourceAnnotationCollectionsealed Represents a collection of resource metadata annotations.
enum
ResourceAnnotationMutationBehavior Specifies behavior of the
IResourceBuilder`1.WithAnnotation method when adding an annotation to the IResource.Annotations collection of a resource. class
ResourceCommandAnnotationsealed Represents a command annotation for a resource.
class
ResourceCommandService A service to execute resource commands.
record
ResourceCommandSnapshotsealed A snapshot of a resource command.
enum
ResourceCommandState The state of a resource command.
enum
ResourceCommandVisibility Describes where a resource command is visible.
enum
ResourceDependencyDiscoveryMode Represents the mode for discovering resource dependencies.
class
ResourceDependencyDiscoveryOptionssealed Changes how resource dependencies are discovered.
class
ResourceEndpointsAllocatedEventats export This event is raised by orchestrators to signal to resources that their endpoints have been allocated.
class
ResourceEvent Represents a change in the state of a resource.
class
ResourceExtensionsstatic Provides extension methods for the
IResource interface. class
ResourceIconAnnotationsealed Specifies the icon to use when displaying a resource in the dashboard.
class
ResourceLoggerService A service that provides loggers for resources to write to.
class
ResourceNameAttributesealed Signifies that a parameter represents a resource name.
Decorate String parameters representing resource names with this attribute, e.g.: public static IResourceBuilder<MyResource> AddCustomResource( this IDistributedApplicationBuilder builder, [ResourceName] string name)
class
ResourceNotificationService A service that allows publishing and subscribing to changes in the state of a resource.
class
ResourceNotificationServiceOptionssealed Options for the
ResourceNotificationService. record
ResourcePropertySnapshotsealed A snapshot of the resource property.
class
ResourceReadyEventats export Event that is raised when a resource initially transitions to a ready state.
class
ResourceRelationshipAnnotationsealed An annotation which represents the relationship between two resources.
class
ResourceSnapshotAnnotation An annotation that represents the initial snapshot of a resource.
record
ResourceStateSnapshotsealed A snapshot of the resource state
class
ResourceStoppedEventats export This event is raised after a resource has stopped.
class
ResourceUrlAnnotationsealeddto A URL that should be displayed for a resource.
class
ResourceUrlsCallbackAnnotationsealed Represents an annotation that provides a callback to modify URLs that should be displayed for the resource.
class
ResourceUrlsCallbackContextats export Represents a callback context for resource URLs.
class
UpdateCommandStateContextsealedats export Context for
ResourceCommandAnnotation.UpdateState. enum
UrlDisplayLocation Specifies where the URL should be displayed.
record
UrlDisplayPropertiesSnapshotsealed A snapshot of the display properties for a url.
record
UrlSnapshotsealed A snapshot of the URL.
class
ValueProviderContext Provides context for value resolution.
class
ValueSnapshot<T>sealed Provides an asynchronously initialized value that: - Can be awaited via GetValueAsync() until the first value or exception is set. - Exposes the latest value after it has been set (supports re-setting). - Tracks whether a value or exception was ever set via IsValueSet. - Supports setting an exception that will be thrown by GetValueAsync. Thread-safe for concurrent SetValue / SetException / GetValueAsync calls.
record
VolumeSnapshotsealed A snapshot of a volume, mounted to a container.
class
WaitAnnotationsealed Represents a wait relationship between two resources.
enum
WaitBehavior Specifies the behavior of the wait.
enum
WaitType Specifies the type of Wait applied to dependency resources.
Aspire.Hosting.ApplicationModel.Docker (4)
class
ContainerFilesExtensionsstatic Provides Dockerfile builder extension methods for supporting
ResourceBuilderExtensions.PublishWithContainerFiles. class
DockerfileBuilderats export Builder for creating Dockerfiles programmatically.
class
DockerfileStageats export Represents a stage within a multi-stage Dockerfile.
class
DockerfileStatementabstract Represents a statement that can be written to a Dockerfile.
Aspire.Hosting.Eventing (7)
class
DistributedApplicationEventing Supports publishing and subscribing to events which are executed during the AppHost lifecycle.
class
DistributedApplicationEventSubscriptionats export Represents a subscription to an event that is published during the lifecycle of the AppHost.
class
DistributedApplicationResourceEventSubscriptionats export Represents a subscription to an event that is published during the lifecycle of the AppHost for a specific resource.
enum
EventDispatchBehavior Controls how events are dispatched to subscribers.
interface
IDistributedApplicationEventats export Represents an event that is published during the lifecycle of the AppHost.
interface
IDistributedApplicationEventingats export Supports publishing and subscribing to events which are executed during the AppHost lifecycle.
interface
IDistributedApplicationResourceEventats export Represents an event that is published during the lifecycle of the AppHost for a specific resource.
Aspire.Hosting.Lifecycle (4)
class
EventingSubscriberServiceCollectionExtensionsstatic Provides extension methods for adding event subscribers to the
DependencyInjection.IServiceCollection. interface
IDistributedApplicationEventingSubscriber Defines an interface for services that want to subscribe to events from IDistributedApplicationEventing. This allows a service to subscribe to BeforeStartEvent before the application actually starts.
interface
IDistributedApplicationLifecycleHookobsolete Defines an interface for hooks that are executed during the lifecycle of a distributed application.
class
LifecycleHookServiceCollectionExtensionsstatic Provides extension methods for adding lifecycle hooks to the
DependencyInjection.IServiceCollection. Aspire.Hosting.Pipelines (27)
enum
CompletionState Represents the completion state of a publishing activity (task, step, or top-level operation).
class
DeploymentStateSectionsealed Represents a section of deployment state with version tracking for concurrency control.
class
DistributedApplicationPipelineExtensionsstatic Extension methods for
IDistributedApplicationPipeline. interface
IDeploymentStateManager Provides deployment state management functionality.
interface
IDistributedApplicationPipeline Represents a pipeline for executing deployment steps in a distributed application.
interface
IPipelineActivityReporter Interface for reporting publishing activities.
interface
IPipelineOutputService Service for managing pipeline output directories.
interface
IReportingStep Represents a publishing step, which can contain multiple tasks.
interface
IReportingTask Represents a publishing task, which belongs to a step.
class
MarkdownStringsealed Represents a string that contains Markdown-formatted content.
class
NullPublishingActivityReportersealed A no-op implementation of
IPipelineActivityReporter for testing purposes. class
PipelineConfigurationAnnotation An annotation that registers a callback to execute during the pipeline configuration phase, allowing modification of step dependencies and relationships.
class
PipelineConfigurationContextats export Provides contextual information for pipeline configuration callbacks.
class
PipelineContextsealedats export Provides contextual information and services for the pipeline execution process of a distributed application.
class
PipelineOptions Represents the options for executing a pipeline.
class
PipelineStepats export Represents a step in the deployment pipeline.
class
PipelineStepAnnotation An annotation that creates pipeline steps for a resource during deployment.
class
PipelineStepContextsealedats export Provides contextual information for a specific pipeline step execution.
class
PipelineStepExtensionsstatic Extension methods for pipeline steps.
class
PipelineStepFactoryContextats export Provides contextual information for creating pipeline steps from a
PipelineStepAnnotation. class
PipelineStepFactoryExtensionsstatic Provides extension methods for adding pipeline steps to resources.
class
PipelineSummarysealedats export Represents pipeline summary information to be displayed after pipeline completion. This is a general-purpose key-value collection that pipeline steps can contribute to.
class
PipelineSummaryItemsealed Represents a single item in a
PipelineSummary, consisting of a key, a value, and a flag indicating whether the value contains Markdown formatting. class
PublishCompletionOptionssealed Options for completing the publishing process.
class
PublishingExtensionsstaticats ignored Extension methods for
IReportingStep and IReportingTask to provide direct operations. class
WellKnownPipelineStepsstatic Defines well-known pipeline step names used in the deployment pipeline.
class
WellKnownPipelineTagsstatic Defines well-known pipeline tags used to categorize pipeline steps.
Aspire.Hosting.Publishing (17)
class
AfterPublishEventsealedats export This event is published after the distributed application is published.
class
BeforePublishEventsealedats export This event is published before the distributed application is published.
enum
BuildImageSecretType Specifies the type of a build secret.
record
BuildImageSecretValue Represents a resolved build secret with its value and type.
class
ComposeOperationContextsealed Provides the parameters needed to execute a Docker Compose operation against a container runtime.
class
ComposeServiceInfosealed Represents a running service discovered from a compose environment.
class
ComposeServicePortsealed Represents a port mapping for a compose service.
class
ContainerImageBuildOptions Options for building container images.
enum
ContainerImageDestination Specifies the destination for container images.
enum
ContainerImageFormat Specifies the format for container images.
enum
ContainerTargetPlatform Specifies the target platform for container images.
interface
IContainerRuntime Represents a container runtime (e.g., Docker, Podman) that can be used to build, tag, push, and manage container images.
interface
IContainerRuntimeResolver Resolves the configured or auto-detected container runtime asynchronously. The result is cached after the first resolution.
interface
IDistributedApplicationPublisherobsolete Defines the interface for publishing a distributed application.
interface
IResourceContainerImageManager Provides a service to publishers for building and pushing container images that represent a resource.
class
ManifestPublishingContextsealed Contextual information used for manifest publishing during this execution of the AppHost.
class
PublishingOptionsobsolete Represents the options for publishing an application.
SHA — c35a18d© Microsoft