Aspire.Hosting.ApplicationModel Namespace

Classes

AfterEndpointsAllocatedEvent

This event is published after all endpoints have been allocated.

AfterResourcesCreatedEvent

This event is published after all resources have been created.

AllocatedEndpoint

Represents an endpoint allocated for a service instance.

AzureOpenAIDeployment

Represents an Azure OpenAI Deployment.

AzureOpenAIResource

Represents an Azure OpenAI resource.

AzureSignalRResource

Represents an Azure SignalR resource.

AzureWebPubSubHubResource

Represents an Azure Web PubSub Hub setting resource.

AzureWebPubSubResource

Represents an Azure Web PubSub resource.

BeforeResourceStartedEvent

This event is raised by orchestrators before they have started a new resource.

BeforeStartEvent

This event is published before the application starts.

CommandLineArgsCallbackAnnotation

Represents an annotation that provides a callback to be executed with a list of command-line arguments when an executable resource is started.

CommandLineArgsCallbackContext

Represents a callback context for the list of command-line arguments associated with an executable resource.

CommandResults

A factory for ExecuteCommandResult.

ConnectionStringAvailableEvent

The ConnectionStringAvailableEvent is raised when a connection string becomes available for a resource.

ConnectionStringRedirectAnnotation

Links to a resource that implements IResourceWithConnectionString that can be used by the containing resource to acquire a connection string.

ConnectionStringReference

Represents a reference to a connection string.

ContainerImageAnnotation

Represents an annotation for a container image.

ContainerLifetimeAnnotation

Annotation that controls the lifetime of a container resource.

ContainerMountAnnotation

Represents a mount annotation for a container resource.

ContainerNameAnnotation

Represents an annotation for a custom container name.

ContainerResource

A resource that represents a specified container.

ContainerRuntimeArgsCallbackAnnotation

Represents an additional argument to pass to the container runtime run command.

ContainerRuntimeArgsCallbackContext

Represents a callback context for the list of command-line arguments to be passed to the container runtime run command.

CustomResourceKnownProperties

Known properties for resources that show up in the dashboard.

CustomResourceSnapshot

An immutable snapshot of the state of a resource.

DeploymentTargetAnnotation

Represents an annotation for a deployment target.

DisableForwardedHeadersAnnotation

Represents an annotation that disables enabling forwarded headers on ASP.NET Core projects on publish.

DistributedApplicationModel

Represents a distributed application.

DockerBuildArg

Represents a name/value pair, used to satisfy the docker builder --build-arg <NAME>[=<VALUE>] command switch. For more information, see .

DockerfileBuildAnnotation

Represents an annotation for customizing a Dockerfile build.

ElasticsearchResource

A resource that represents a Elasticsearch

EndpointAnnotation

Represents an endpoint annotation that describes how a service should be bound to a network.

EndpointNameAttribute

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)

EndpointReference

Represents an endpoint reference for a resource with endpoints.

EndpointReferenceExpression

Represents a property expression for an endpoint reference.

EnvironmentCallbackAnnotation

Represents an annotation that provides a callback to modify the environment variables of an application.

EnvironmentCallbackContext

Represents a callback context for environment variables associated with a publisher.

EnvironmentVariableSnapshot

A snapshot of an environment variable.

ExecutableResource

A resource that represents a specified executable process.

ExecuteCommandContext

Context for ExecuteCommand.

ExecuteCommandResult

The result of executing a command. Returned from ExecuteCommand.

GarnetResource

A resource that represents a Garnet resource independent of the hosting model.

GenerateParameterDefault

Represents that a default value should be generated.

HealthCheckAnnotation

An annotation which tracks the name of the health check used to detect to health of a resource.

HealthReportSnapshot

A report produced by a health check about a resource.

HostUrl

Represents a URL on the host machine. When referenced in a container resource, localhost will be replaced with the configured container host name.

KeycloakResource

A resource that represents a Keycloak resource.

KnownResourceStates

The set of well known resource states.

KnownResourceStateStyles

The set of well known resource states.

ManifestPublishingCallbackAnnotation

Represents an annotation that provides a callback to be executed during manifest publishing.

MilvusDatabaseResource

A resource that represents a Milvus database. This is a child resource of a MilvusServerResource.

MongoDBDatabaseResource

A resource that represents a MongoDB database. This is a child resource of a MongoDBServerResource.

MongoDBServerResource

A resource that represents a MongoDB container.

MySqlDatabaseResource

A resource that represents a MySQL database. This is a child resource of a MySqlServerResource.

MySqlServerResource

A resource that represents a MySQL container.

NatsServerResource

A resource that represents a NATS server container.

OracleDatabaseResource

A resource that represents an Oracle Database database. This is a child resource of a OracleDatabaseServerResource.

OracleDatabaseServerResource

A resource that represents an Oracle Database container.

ParameterDefault

Represents how a default value should be retrieved.

ParameterResource

Represents a parameter resource.

PostgresDatabaseResource

A resource that represents a PostgreSQL database. This is a child resource of a PostgresServerResource.

PostgresServerResource

A resource that represents a PostgreSQL container.

ProjectResource

A resource that represents a specified .NET project.

ProjectResourceExtensions

Provides extension methods for DistributedApplicationModel to work with ProjectResource instances.

QdrantServerResource

A resource that represents a Qdrant database.

RabbitMQServerResource

A resource that represents a RabbitMQ resource.

RedisResource

A resource that represents a Redis resource independent of the hosting model.

ReferenceExpression

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.

ReferenceExpressionBuilder

A builder for creating ReferenceExpression instances.

ReplicaAnnotation

Represents an annotation that specifies the number of replicas for a resource.

Resource

Represents an abstract resource that can be used by an application, that implements IResource.

ResourceAnnotationCollection

Represents a collection of resource metadata annotations.

ResourceCommandAnnotation

Represents a command annotation for a resource.

ResourceCommandSnapshot

A snapshot of a resource command.

ResourceEvent

Represents a change in the state of a resource.

ResourceExtensions

Provides extension methods for the IResource interface.

ResourceLoggerService

A service that provides loggers for resources to write to.

ResourceNameAttribute

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)

ResourceNotificationService

A service that allows publishing and subscribing to changes in the state of a resource.

ResourcePropertySnapshot

A snapshot of the resource property.

ResourceReadyEvent

Event that is raised when a resource initially transitions to a ready state.

ResourceSnapshotAnnotation

An annotation that represents the initial snapshot of a resource.

ResourceStateSnapshot

A snapshot of the resource state

SeqResource

A .NET Aspire resource that is a Seq server.

SqlServerDatabaseResource

A resource that represents a SQL Server database that is a child of a SQL Server container resource.

SqlServerServerResource

A resource that represents a SQL Server container.

UpdateCommandStateContext

Context for UpdateState.

UrlSnapshot

A snapshot of the url.

ValkeyResource

A resource that represents a Valkey resource independent of the hosting model.

VolumeSnapshot

A snapshot of a volume, mounted to a container.

WaitAnnotation

Represents a wait relationship between two resources.

Structs

LogLine

Represents a console log line.

LogSubscriber

Represents a log subscriber for a resource.

ReferenceExpression.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.

ReferenceExpressionBuilder.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.

Interfaces

IAzureResource

Represents an Azure resource, as a marker interface for IResource's that can be deployed to an Azure resource group.

IManifestExpressionProvider

An interface that allows an object to express how it should be represented in a manifest.

IModelNameParameter

Signifies that a parameter represents a model name.

IResource

Represents a resource that can be hosted by an application.

IResourceAnnotation

Represents an annotation for a resource.

IResourceBuilder<T>

Defines a builder for creating resources of type T.

IResourceCollection

Represents a collection of resources.

IResourceWithArgs

Represents a resource that is associated with commandline arguments.

IResourceWithConnectionString

Represents a resource that has a connection string associated with it.

IResourceWithEndpoints

Represents a resource that has endpoints associated with it.

IResourceWithEnvironment

Represents a resource that is associated with an environment.

IResourceWithParent

Represents a resource that has a parent resource.

IResourceWithParent<T>

Represents a resource that has a parent resource of type T.

IResourceWithWaitSupport

Represents a resource that can wait for other resources to be running, health, and/or completed.

IValueProvider

An interface that allows the value to be provided for an environment variable.

IValueWithReferences

An interface that allows the value to list its references.

Enums

ContainerLifetime

Lifetime modes for container resources.

ContainerMountType

Represents the type of a container mount.

EndpointProperty

Represents the properties of an endpoint that can be referenced.

IconVariant

The icon variant.

ResourceAnnotationMutationBehavior

Specifies behavior of the WithAnnotation<TAnnotation>(ResourceAnnotationMutationBehavior) method when adding an annotation to the Annotations collection of a resource.

ResourceCommandState

The state of a resource command.

WaitType

Specifies the type of Wait applied to dependency resources.