# Aspire.Hosting

- Module: `Aspire.Hosting`
- Version: `13.3.0`
- Source: [GitHub](https://github.com/microsoft/aspire)
- Functions: `188`
- Types: `102`

## Types

- [AddContainerOptions](/reference/api/typescript/aspire.hosting/addcontaineroptions.md) -- `type` - 2 fields
- [AfterResourcesCreatedEvent](/reference/api/typescript/aspire.hosting/afterresourcescreatedevent.md) -- `handle` - 2 members
- [BeforeResourceStartedEvent](/reference/api/typescript/aspire.hosting/beforeresourcestartedevent.md) -- `handle` - 2 members
- [BeforeStartEvent](/reference/api/typescript/aspire.hosting/beforestartevent.md) -- `handle` - 2 members
- [CertificateTrustExecutionConfigurationContext](/reference/api/typescript/aspire.hosting/certificatetrustexecutionconfigurationcontext.md) -- `type` - 4 fields
- [CertificateTrustExecutionConfigurationExportData](/reference/api/typescript/aspire.hosting/certificatetrustexecutionconfigurationexportdata.md) -- `type` - 3 fields
- [CommandLineArgsCallbackContext](/reference/api/typescript/aspire.hosting/commandlineargscallbackcontext.md) -- `handle` - 4 members
- [CommandLineArgsEditor](/reference/api/typescript/aspire.hosting/commandlineargseditor.md) -- `handle` - 1 members
- [CommandOptions](/reference/api/typescript/aspire.hosting/commandoptions.md) -- `type` - 7 fields
- [CommandResultData](/reference/api/typescript/aspire.hosting/commandresultdata.md) -- `type` - 3 fields
- [ConnectionStringAvailableEvent](/reference/api/typescript/aspire.hosting/connectionstringavailableevent.md) -- `handle` - 2 members
- [ContainerImagePushOptions](/reference/api/typescript/aspire.hosting/containerimagepushoptions.md) -- `handle` - 4 members
- [ContainerImagePushOptionsCallbackContext](/reference/api/typescript/aspire.hosting/containerimagepushoptionscallbackcontext.md) -- `handle` - 6 members
- [ContainerImageReference](/reference/api/typescript/aspire.hosting/containerimagereference.md) -- `handle` - 0 members
- [ContainerMountAnnotation](/reference/api/typescript/aspire.hosting/containermountannotation.md) -- `handle` - 0 members
- [ContainerPortReference](/reference/api/typescript/aspire.hosting/containerportreference.md) -- `handle` - 0 members
- [ContainerRegistryResource](/reference/api/typescript/aspire.hosting/containerregistryresource.md) -- `handle` - 0 members
- [ContainerResource](/reference/api/typescript/aspire.hosting/containerresource.md) -- `handle` - 20 members
- [CreateBuilderOptions](/reference/api/typescript/aspire.hosting/createbuilderoptions.md) -- `type` - 8 fields
- [CSharpAppResource](/reference/api/typescript/aspire.hosting/csharpappresource.md) -- `handle` - 0 members
- [DistributedApplication](/reference/api/typescript/aspire.hosting/distributedapplication.md) -- `handle` - 1 members
- [DistributedApplicationEventSubscription](/reference/api/typescript/aspire.hosting/distributedapplicationeventsubscription.md) -- `handle` - 0 members
- [DistributedApplicationExecutionContext](/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontext.md) -- `handle` - 6 members
- [DistributedApplicationExecutionContextOptions](/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontextoptions.md) -- `handle` - 0 members
- [DistributedApplicationModel](/reference/api/typescript/aspire.hosting/distributedapplicationmodel.md) -- `handle` - 2 members
- [DistributedApplicationResourceEventSubscription](/reference/api/typescript/aspire.hosting/distributedapplicationresourceeventsubscription.md) -- `handle` - 0 members
- [DockerfileBuilder](/reference/api/typescript/aspire.hosting/dockerfilebuilder.md) -- `handle` - 3 members
- [DockerfileBuilderCallbackContext](/reference/api/typescript/aspire.hosting/dockerfilebuildercallbackcontext.md) -- `handle` - 4 members
- [DockerfileStage](/reference/api/typescript/aspire.hosting/dockerfilestage.md) -- `handle` - 14 members
- [DotnetToolResource](/reference/api/typescript/aspire.hosting/dotnettoolresource.md) -- `handle` - 6 members
- [EndpointReference](/reference/api/typescript/aspire.hosting/endpointreference.md) -- `handle` - 19 members
- [EndpointReferenceExpression](/reference/api/typescript/aspire.hosting/endpointreferenceexpression.md) -- `handle` - 3 members
- [EndpointUpdateContext](/reference/api/typescript/aspire.hosting/endpointupdatecontext.md) -- `handle` - 21 members
- [EnvironmentCallbackContext](/reference/api/typescript/aspire.hosting/environmentcallbackcontext.md) -- `handle` - 4 members
- [EnvironmentEditor](/reference/api/typescript/aspire.hosting/environmenteditor.md) -- `handle` - 1 members
- [EventingSubscriberRegistrationContext](/reference/api/typescript/aspire.hosting/eventingsubscriberregistrationcontext.md) -- `handle` - 4 members
- [ExecutableResource](/reference/api/typescript/aspire.hosting/executableresource.md) -- `handle` - 3 members
- [ExecuteCommandContext](/reference/api/typescript/aspire.hosting/executecommandcontext.md) -- `handle` - 8 members
- [ExecuteCommandResult](/reference/api/typescript/aspire.hosting/executecommandresult.md) -- `type` - 5 fields
- [ExternalServiceResource](/reference/api/typescript/aspire.hosting/externalserviceresource.md) -- `handle` - 1 members
- [GenerateParameterDefault](/reference/api/typescript/aspire.hosting/generateparameterdefault.md) -- `type` - 9 fields
- [HttpCommandExportOptions](/reference/api/typescript/aspire.hosting/httpcommandexportoptions.md) -- `type` - 9 fields
- [HttpsCertificateExecutionConfigurationContext](/reference/api/typescript/aspire.hosting/httpscertificateexecutionconfigurationcontext.md) -- `type` - 3 fields
- [HttpsCertificateExecutionConfigurationExportData](/reference/api/typescript/aspire.hosting/httpscertificateexecutionconfigurationexportdata.md) -- `type` - 7 fields
- [HttpsCertificateInfo](/reference/api/typescript/aspire.hosting/httpscertificateinfo.md) -- `type` - 3 fields
- [IAspireStore](/reference/api/typescript/aspire.hosting/iaspirestore.md) -- `interface` - 1 members
- [IDistributedApplicationBuilder](/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder.md) -- `interface` - 25 members
- [IDistributedApplicationEvent](/reference/api/typescript/aspire.hosting/idistributedapplicationevent.md) -- `interface` - 0 members
- [IDistributedApplicationEventing](/reference/api/typescript/aspire.hosting/idistributedapplicationeventing.md) -- `interface` - 1 members
- [IDistributedApplicationPipeline](/reference/api/typescript/aspire.hosting/idistributedapplicationpipeline.md) -- `interface` - 3 members
- [IDistributedApplicationResourceEvent](/reference/api/typescript/aspire.hosting/idistributedapplicationresourceevent.md) -- `interface` - 0 members
- [IExecutionConfigurationBuilder](/reference/api/typescript/aspire.hosting/iexecutionconfigurationbuilder.md) -- `interface` - 5 members
- [IExecutionConfigurationResult](/reference/api/typescript/aspire.hosting/iexecutionconfigurationresult.md) -- `interface` - 2 members
- [IExpressionValue](/reference/api/typescript/aspire.hosting/iexpressionvalue.md) -- `interface` - 0 members
- [InitializeResourceEvent](/reference/api/typescript/aspire.hosting/initializeresourceevent.md) -- `handle` - 5 members
- [IReportingStep](/reference/api/typescript/aspire.hosting/ireportingstep.md) -- `interface` - 6 members
- [IReportingTask](/reference/api/typescript/aspire.hosting/ireportingtask.md) -- `interface` - 4 members
- [IResource](/reference/api/typescript/aspire.hosting/iresource.md) -- `interface` - 23 members
- [IResourceWithArgs](/reference/api/typescript/aspire.hosting/iresourcewithargs.md) -- `interface` - 2 members
- [IResourceWithConnectionString](/reference/api/typescript/aspire.hosting/iresourcewithconnectionstring.md) -- `interface` - 3 members
- [IResourceWithContainerFiles](/reference/api/typescript/aspire.hosting/iresourcewithcontainerfiles.md) -- `interface` - 2 members
- [IResourceWithEndpoints](/reference/api/typescript/aspire.hosting/iresourcewithendpoints.md) -- `interface` - 14 members
- [IResourceWithEnvironment](/reference/api/typescript/aspire.hosting/iresourcewithenvironment.md) -- `interface` - 9 members
- [IResourceWithParent](/reference/api/typescript/aspire.hosting/iresourcewithparent.md) -- `interface` - 0 members
- [IResourceWithWaitSupport](/reference/api/typescript/aspire.hosting/iresourcewithwaitsupport.md) -- `interface` - 3 members
- [IUserSecretsManager](/reference/api/typescript/aspire.hosting/iusersecretsmanager.md) -- `interface` - 6 members
- [LogFacade](/reference/api/typescript/aspire.hosting/logfacade.md) -- `handle` - 4 members
- [ParameterResource](/reference/api/typescript/aspire.hosting/parameterresource.md) -- `handle` - 1 members
- [PipelineConfigurationContext](/reference/api/typescript/aspire.hosting/pipelineconfigurationcontext.md) -- `handle` - 3 members
- [PipelineContext](/reference/api/typescript/aspire.hosting/pipelinecontext.md) -- `handle` - 7 members
- [PipelineEditor](/reference/api/typescript/aspire.hosting/pipelineeditor.md) -- `handle` - 2 members
- [PipelineStep](/reference/api/typescript/aspire.hosting/pipelinestep.md) -- `handle` - 5 members
- [PipelineStepContext](/reference/api/typescript/aspire.hosting/pipelinestepcontext.md) -- `handle` - 10 members
- [PipelineStepFactoryContext](/reference/api/typescript/aspire.hosting/pipelinestepfactorycontext.md) -- `handle` - 4 members
- [PipelineSummary](/reference/api/typescript/aspire.hosting/pipelinesummary.md) -- `handle` - 2 members
- [ProjectResource](/reference/api/typescript/aspire.hosting/projectresource.md) -- `handle` - 3 members
- [ProjectResourceOptions](/reference/api/typescript/aspire.hosting/projectresourceoptions.md) -- `handle` - 6 members
- [ReferenceEnvironmentInjectionOptions](/reference/api/typescript/aspire.hosting/referenceenvironmentinjectionoptions.md) -- `type` - 4 fields
- [ReferenceExpression](/reference/api/typescript/aspire.hosting/referenceexpression.md) -- `handle` - 1 members
- [ReferenceExpressionBuilder](/reference/api/typescript/aspire.hosting/referenceexpressionbuilder.md) -- `handle` - 5 members
- [ResourceEndpointsAllocatedEvent](/reference/api/typescript/aspire.hosting/resourceendpointsallocatedevent.md) -- `handle` - 2 members
- [ResourceEventDto](/reference/api/typescript/aspire.hosting/resourceeventdto.md) -- `type` - 6 fields
- [ResourceLoggerService](/reference/api/typescript/aspire.hosting/resourceloggerservice.md) -- `handle` - 2 members
- [ResourceNotificationService](/reference/api/typescript/aspire.hosting/resourcenotificationservice.md) -- `handle` - 6 members
- [ResourceReadyEvent](/reference/api/typescript/aspire.hosting/resourcereadyevent.md) -- `handle` - 2 members
- [ResourceStoppedEvent](/reference/api/typescript/aspire.hosting/resourcestoppedevent.md) -- `handle` - 2 members
- [ResourceUrlAnnotation](/reference/api/typescript/aspire.hosting/resourceurlannotation.md) -- `type` - 4 fields
- [ResourceUrlsCallbackContext](/reference/api/typescript/aspire.hosting/resourceurlscallbackcontext.md) -- `handle` - 5 members
- [ResourceUrlsEditor](/reference/api/typescript/aspire.hosting/resourceurlseditor.md) -- `handle` - 3 members
- [UpdateCommandStateContext](/reference/api/typescript/aspire.hosting/updatecommandstatecontext.md) -- `handle` - 2 members

## Functions

- [addConnectionString](/reference/api/typescript/aspire.hosting/addconnectionstring.md) -- `method` -- Adds a connection string resource
- [addContainer](/reference/api/typescript/aspire.hosting/addcontainer.md) -- `method` -- Adds a container resource
- [addContainerFiles](/reference/api/typescript/aspire.hosting/addcontainerfiles.md) -- `method` -- Adds COPY --from statements for published container files
- [addContainerFilesStages](/reference/api/typescript/aspire.hosting/addcontainerfilesstages.md) -- `method` -- Adds Dockerfile stages for published container files
- [addContainerRegistry](/reference/api/typescript/aspire.hosting/addcontainerregistry.md) -- `method` -- Adds a container registry resource
- [addCSharpApp](/reference/api/typescript/aspire.hosting/addcsharpapp.md) -- `method` -- Adds a C# application resource
- [addDockerfile](/reference/api/typescript/aspire.hosting/adddockerfile.md) -- `method` -- Adds a container resource built from a Dockerfile
- [addDockerfileBuilder](/reference/api/typescript/aspire.hosting/adddockerfilebuilder.md) -- `method` -- Adds a container resource built from a programmatically generated Dockerfile
- [addDotnetTool](/reference/api/typescript/aspire.hosting/adddotnettool.md) -- `method` -- Adds a .NET tool resource
- [addEventingSubscriber](/reference/api/typescript/aspire.hosting/addeventingsubscriber.md) -- `method` -- Adds an eventing subscriber
- [addExecutable](/reference/api/typescript/aspire.hosting/addexecutable.md) -- `method` -- Adds an executable resource
- [addExternalService](/reference/api/typescript/aspire.hosting/addexternalservice.md) -- `method` -- Adds an external service resource
- [addMarkdown](/reference/api/typescript/aspire.hosting/addmarkdown.md) -- `method` -- Adds a Markdown-formatted value to the pipeline summary
- [addParameter](/reference/api/typescript/aspire.hosting/addparameter.md) -- `method` -- Adds a parameter resource
- [addParameterFromConfiguration](/reference/api/typescript/aspire.hosting/addparameterfromconfiguration.md) -- `method` -- Adds a parameter sourced from configuration
- [addParameterWithGeneratedValue](/reference/api/typescript/aspire.hosting/addparameterwithgeneratedvalue.md) -- `method` -- Adds a parameter with a generated default value
- [addProject](/reference/api/typescript/aspire.hosting/addproject.md) -- `method` -- Adds a .NET project resource
- [addStep](/reference/api/typescript/aspire.hosting/addstep.md) -- `method` -- Adds a pipeline step to the application
- [arg](/reference/api/typescript/aspire.hosting/arg.md) -- `method` -- Adds a global ARG statement to the Dockerfile
- [arg](/reference/api/typescript/aspire.hosting/arg.md) -- `method` -- Adds an ARG statement to a Dockerfile stage
- [asHttp2Service](/reference/api/typescript/aspire.hosting/ashttp2service.md) -- `method` -- Configures resource for HTTP/2
- [build](/reference/api/typescript/aspire.hosting/build.md) -- `method` -- Builds the execution configuration
- [clearContainerFilesSources](/reference/api/typescript/aspire.hosting/clearcontainerfilessources.md) -- `method` -- Clears all container file sources
- [cmd](/reference/api/typescript/aspire.hosting/cmd.md) -- `method` -- Adds a CMD statement to a Dockerfile stage
- [comment](/reference/api/typescript/aspire.hosting/comment.md) -- `method` -- Adds a comment to a Dockerfile stage
- [completeLog](/reference/api/typescript/aspire.hosting/completelog.md) -- `method` -- Completes the log stream for a resource
- [completeLogByName](/reference/api/typescript/aspire.hosting/completelogbyname.md) -- `method` -- Completes the log stream by resource name
- [completeStep](/reference/api/typescript/aspire.hosting/completestep.md) -- `method` -- Completes the reporting step with plain-text completion text
- [completeStepMarkdown](/reference/api/typescript/aspire.hosting/completestepmarkdown.md) -- `method` -- Completes the reporting step with Markdown-formatted completion text
- [completeTask](/reference/api/typescript/aspire.hosting/completetask.md) -- `method` -- Completes the reporting task with plain-text completion text
- [completeTaskMarkdown](/reference/api/typescript/aspire.hosting/completetaskmarkdown.md) -- `method` -- Completes the reporting task with Markdown-formatted completion text
- [configure](/reference/api/typescript/aspire.hosting/configure.md) -- `method` -- Configures the application pipeline via a callback
- [copy](/reference/api/typescript/aspire.hosting/copy.md) -- `method` -- Adds a COPY statement to a Dockerfile stage
- [copyFrom](/reference/api/typescript/aspire.hosting/copyfrom.md) -- `method` -- Adds a COPY --from statement to a Dockerfile stage
- [createBuilder](/reference/api/typescript/aspire.hosting/createbuilder.md) -- `method` -- Creates a new distributed application builder
- [createExecutionConfiguration](/reference/api/typescript/aspire.hosting/createexecutionconfiguration.md) -- `method` -- Creates an execution configuration builder
- [createLogger](/reference/api/typescript/aspire.hosting/createlogger.md) -- `method` -- Creates a logger for a category
- [createMarkdownTask](/reference/api/typescript/aspire.hosting/createmarkdowntask.md) -- `method` -- Creates a reporting task with Markdown-formatted status text
- [createTask](/reference/api/typescript/aspire.hosting/createtask.md) -- `method` -- Creates a reporting task with plain-text status text
- [disableBuildOnlyContainerValidation](/reference/api/typescript/aspire.hosting/disablebuildonlycontainervalidation.md) -- `method` -- Disables publish and deploy validation for unconsumed build-only containers.
- [disableForwardedHeaders](/reference/api/typescript/aspire.hosting/disableforwardedheaders.md) -- `method` -- Disables forwarded headers for the project
- [emptyLine](/reference/api/typescript/aspire.hosting/emptyline.md) -- `method` -- Adds an empty line to a Dockerfile stage
- [entrypoint](/reference/api/typescript/aspire.hosting/entrypoint.md) -- `method` -- Adds an ENTRYPOINT statement to a Dockerfile stage
- [env](/reference/api/typescript/aspire.hosting/env.md) -- `method` -- Adds an ENV statement to a Dockerfile stage
- [excludeFromManifest](/reference/api/typescript/aspire.hosting/excludefrommanifest.md) -- `method` -- Excludes the resource from the deployment manifest
- [excludeFromMcp](/reference/api/typescript/aspire.hosting/excludefrommcp.md) -- `method` -- Excludes the resource from MCP server exposure
- [exists](/reference/api/typescript/aspire.hosting/exists.md) -- `method` -- Checks whether a configuration section exists
- [expose](/reference/api/typescript/aspire.hosting/expose.md) -- `method` -- Adds an EXPOSE statement to a Dockerfile stage
- [findResourceByName](/reference/api/typescript/aspire.hosting/findresourcebyname.md) -- `method` -- Finds a resource by name
- [from](/reference/api/typescript/aspire.hosting/from.md) -- `method` -- Adds a FROM statement to start a Dockerfile stage
- [getAspireStore](/reference/api/typescript/aspire.hosting/getaspirestore.md) -- `method` -- Gets the Aspire store from the service provider
- [getCertificateTrustData](/reference/api/typescript/aspire.hosting/getcertificatetrustdata.md) -- `method` -- Gets certificate trust execution-configuration data
- [getChildren](/reference/api/typescript/aspire.hosting/getchildren.md) -- `method` -- Gets child configuration sections
- [getConfiguration](/reference/api/typescript/aspire.hosting/getconfiguration.md) -- `method` -- Gets the application configuration
- [getConfigValue](/reference/api/typescript/aspire.hosting/getconfigvalue.md) -- `method` -- Gets a configuration value by key
- [getConnectionProperty](/reference/api/typescript/aspire.hosting/getconnectionproperty.md) -- `method` -- Gets a connection property by key
- [getConnectionString](/reference/api/typescript/aspire.hosting/getconnectionstring.md) -- `method` -- Gets a connection string by name
- [getDistributedApplicationModel](/reference/api/typescript/aspire.hosting/getdistributedapplicationmodel.md) -- `method` -- Gets the distributed application model from the service provider
- [getEndpoint](/reference/api/typescript/aspire.hosting/getendpoint.md) -- `method` -- Gets an endpoint reference
- [getEventing](/reference/api/typescript/aspire.hosting/geteventing.md) -- `method` -- Gets the distributed application eventing service from the service provider
- [getFileNameWithContent](/reference/api/typescript/aspire.hosting/getfilenamewithcontent.md) -- `method` -- Gets a deterministic file path for the specified file contents
- [getHttpsCertificateData](/reference/api/typescript/aspire.hosting/gethttpscertificatedata.md) -- `method` -- Gets HTTPS certificate execution-configuration data
- [getLoggerFactory](/reference/api/typescript/aspire.hosting/getloggerfactory.md) -- `method` -- Gets the logger factory from the service provider
- [getOrSetSecret](/reference/api/typescript/aspire.hosting/getorsetsecret.md) -- `method` -- Gets a secret value if it exists, or sets it to the provided value if it does not
- [getResourceLoggerService](/reference/api/typescript/aspire.hosting/getresourceloggerservice.md) -- `method` -- Gets the resource logger service from the service provider
- [getResourceName](/reference/api/typescript/aspire.hosting/getresourcename.md) -- `method` -- Gets the resource name
- [getResourceNotificationService](/reference/api/typescript/aspire.hosting/getresourcenotificationservice.md) -- `method` -- Gets the resource notification service from the service provider
- [getResources](/reference/api/typescript/aspire.hosting/getresources.md) -- `method` -- Gets resources from the distributed application model
- [getSection](/reference/api/typescript/aspire.hosting/getsection.md) -- `method` -- Gets a configuration section by key
- [getUserSecretsManager](/reference/api/typescript/aspire.hosting/getusersecretsmanager.md) -- `method` -- Gets the user secrets manager from the service provider
- [isDevelopment](/reference/api/typescript/aspire.hosting/isdevelopment.md) -- `method` -- Checks if running in Development environment
- [isEnvironment](/reference/api/typescript/aspire.hosting/isenvironment.md) -- `method` -- Checks if the environment matches the specified name
- [isProduction](/reference/api/typescript/aspire.hosting/isproduction.md) -- `method` -- Checks if running in Production environment
- [isStaging](/reference/api/typescript/aspire.hosting/isstaging.md) -- `method` -- Checks if running in Staging environment
- [log](/reference/api/typescript/aspire.hosting/log.md) -- `method` -- Logs a message with specified level
- [logDebug](/reference/api/typescript/aspire.hosting/logdebug.md) -- `method` -- Logs a debug message
- [logError](/reference/api/typescript/aspire.hosting/logerror.md) -- `method` -- Logs an error message
- [logInformation](/reference/api/typescript/aspire.hosting/loginformation.md) -- `method` -- Logs an information message
- [logStep](/reference/api/typescript/aspire.hosting/logstep.md) -- `method` -- Logs a plain-text message for the reporting step
- [logStepMarkdown](/reference/api/typescript/aspire.hosting/logstepmarkdown.md) -- `method` -- Logs a Markdown-formatted message for the reporting step
- [logWarning](/reference/api/typescript/aspire.hosting/logwarning.md) -- `method` -- Logs a warning message
- [onAfterResourcesCreated](/reference/api/typescript/aspire.hosting/onafterresourcescreated.md) -- `method` -- Subscribes an eventing subscriber to the AfterResourcesCreated event
- [onBeforeResourceStarted](/reference/api/typescript/aspire.hosting/onbeforeresourcestarted.md) -- `method` -- Subscribes to the BeforeResourceStarted event
- [onBeforeStart](/reference/api/typescript/aspire.hosting/onbeforestart.md) -- `method` -- Subscribes an eventing subscriber to the BeforeStart event
- [onConnectionStringAvailable](/reference/api/typescript/aspire.hosting/onconnectionstringavailable.md) -- `method` -- Subscribes to the ConnectionStringAvailable event
- [onInitializeResource](/reference/api/typescript/aspire.hosting/oninitializeresource.md) -- `method` -- Subscribes to the InitializeResource event
- [onResourceEndpointsAllocated](/reference/api/typescript/aspire.hosting/onresourceendpointsallocated.md) -- `method` -- Subscribes to the ResourceEndpointsAllocated event
- [onResourceReady](/reference/api/typescript/aspire.hosting/onresourceready.md) -- `method` -- Subscribes to the ResourceReady event
- [onResourceStopped](/reference/api/typescript/aspire.hosting/onresourcestopped.md) -- `method` -- Subscribes to the ResourceStopped event
- [publishAsConnectionString](/reference/api/typescript/aspire.hosting/publishasconnectionstring.md) -- `method` -- Publishes the resource as a connection string
- [publishAsContainer](/reference/api/typescript/aspire.hosting/publishascontainer.md) -- `method` -- Configures the resource to be published as a container
- [publishAsDockerFile](/reference/api/typescript/aspire.hosting/publishasdockerfile.md) -- `method` -- Publishes an executable as a Docker file
- [publishAsDockerFile](/reference/api/typescript/aspire.hosting/publishasdockerfile.md) -- `method` -- Publishes a project as a Docker file with optional container configuration
- [publishResourceUpdate](/reference/api/typescript/aspire.hosting/publishresourceupdate.md) -- `method` -- Publishes an update for a resource's state
- [publishWithContainerFiles](/reference/api/typescript/aspire.hosting/publishwithcontainerfiles.md) -- `method` -- Configures the resource to copy container files from the specified source during publishing
- [run](/reference/api/typescript/aspire.hosting/run.md) -- `method` -- Adds a RUN statement to a Dockerfile stage
- [runWithMounts](/reference/api/typescript/aspire.hosting/runwithmounts.md) -- `method` -- Adds a RUN statement with mounts to a Dockerfile stage
- [saveStateJson](/reference/api/typescript/aspire.hosting/savestatejson.md) -- `method` -- Saves state to user secrets from a JSON string
- [subscribeAfterResourcesCreated](/reference/api/typescript/aspire.hosting/subscribeafterresourcescreated.md) -- `method` -- Subscribes to the AfterResourcesCreated event
- [subscribeBeforeStart](/reference/api/typescript/aspire.hosting/subscribebeforestart.md) -- `method` -- Subscribes to the BeforeStart event
- [tryAddEventingSubscriber](/reference/api/typescript/aspire.hosting/tryaddeventingsubscriber.md) -- `method` -- Attempts to add an eventing subscriber
- [tryGetResourceState](/reference/api/typescript/aspire.hosting/trygetresourcestate.md) -- `method` -- Tries to get the current state of a resource
- [updateTask](/reference/api/typescript/aspire.hosting/updatetask.md) -- `method` -- Updates the reporting task with plain-text status text
- [updateTaskMarkdown](/reference/api/typescript/aspire.hosting/updatetaskmarkdown.md) -- `method` -- Updates the reporting task with Markdown-formatted status text
- [user](/reference/api/typescript/aspire.hosting/user.md) -- `method` -- Adds a USER statement to a Dockerfile stage
- [waitFor](/reference/api/typescript/aspire.hosting/waitfor.md) -- `method` -- Waits for another resource to be ready
- [waitForCompletion](/reference/api/typescript/aspire.hosting/waitforcompletion.md) -- `method` -- Waits for resource completion
- [waitForDependencies](/reference/api/typescript/aspire.hosting/waitfordependencies.md) -- `method` -- Waits for all dependencies of a resource to be ready
- [waitForResourceHealthy](/reference/api/typescript/aspire.hosting/waitforresourcehealthy.md) -- `method` -- Waits for a resource to become healthy
- [waitForResourceState](/reference/api/typescript/aspire.hosting/waitforresourcestate.md) -- `method` -- Waits for a resource to reach a specified state
- [waitForResourceStates](/reference/api/typescript/aspire.hosting/waitforresourcestates.md) -- `method` -- Waits for a resource to reach one of the specified states
- [waitForStart](/reference/api/typescript/aspire.hosting/waitforstart.md) -- `method` -- Waits for another resource to start
- [withArgs](/reference/api/typescript/aspire.hosting/withargs.md) -- `method` -- Adds arguments
- [withArgsCallback](/reference/api/typescript/aspire.hosting/withargscallback.md) -- `method` -- Sets command-line arguments via callback
- [withArgumentsConfig](/reference/api/typescript/aspire.hosting/withargumentsconfig.md) -- `method` -- Adds an arguments configuration gatherer
- [withBindMount](/reference/api/typescript/aspire.hosting/withbindmount.md) -- `method` -- Adds a bind mount
- [withBuildArg](/reference/api/typescript/aspire.hosting/withbuildarg.md) -- `method` -- Adds a build argument from a string value or parameter resource
- [withBuildSecret](/reference/api/typescript/aspire.hosting/withbuildsecret.md) -- `method` -- Adds a build secret from a parameter resource
- [withCertificateTrustConfig](/reference/api/typescript/aspire.hosting/withcertificatetrustconfig.md) -- `method` -- Adds a certificate trust configuration gatherer
- [withCertificateTrustScope](/reference/api/typescript/aspire.hosting/withcertificatetrustscope.md) -- `method` -- Sets the certificate trust scope
- [withChildRelationship](/reference/api/typescript/aspire.hosting/withchildrelationship.md) -- `method` -- Sets a child relationship
- [withCommand](/reference/api/typescript/aspire.hosting/withcommand.md) -- `method` -- Adds a resource command
- [withConnectionProperty](/reference/api/typescript/aspire.hosting/withconnectionproperty.md) -- `method` -- Adds a connection property with a string or reference expression value
- [withContainerCertificatePaths](/reference/api/typescript/aspire.hosting/withcontainercertificatepaths.md) -- `method` -- Overrides container certificate bundle and directory paths used for trust configuration
- [withContainerFilesSource](/reference/api/typescript/aspire.hosting/withcontainerfilessource.md) -- `method` -- Sets the source directory for container files
- [withContainerName](/reference/api/typescript/aspire.hosting/withcontainername.md) -- `method` -- Sets the container name
- [withContainerNetworkAlias](/reference/api/typescript/aspire.hosting/withcontainernetworkalias.md) -- `method` -- Adds a network alias for the container
- [withContainerRegistry](/reference/api/typescript/aspire.hosting/withcontainerregistry.md) -- `method` -- Configures a resource to use a container registry
- [withContainerRuntimeArgs](/reference/api/typescript/aspire.hosting/withcontainerruntimeargs.md) -- `method` -- Adds runtime arguments for the container
- [withDescription](/reference/api/typescript/aspire.hosting/withdescription.md) -- `method` -- Sets a parameter description
- [withDeveloperCertificateTrust](/reference/api/typescript/aspire.hosting/withdevelopercertificatetrust.md) -- `method` -- Configures developer certificate trust
- [withDockerfile](/reference/api/typescript/aspire.hosting/withdockerfile.md) -- `method` -- Configures the resource to use a Dockerfile
- [withDockerfileBaseImage](/reference/api/typescript/aspire.hosting/withdockerfilebaseimage.md) -- `method` -- Sets the base image for a Dockerfile build
- [withDockerfileBuilder](/reference/api/typescript/aspire.hosting/withdockerfilebuilder.md) -- `method` -- Configures the resource to use a programmatically generated Dockerfile
- [withEndpoint](/reference/api/typescript/aspire.hosting/withendpoint.md) -- `method` -- Adds a network endpoint
- [withEndpointCallback](/reference/api/typescript/aspire.hosting/withendpointcallback.md) -- `method` -- Updates a named endpoint via callback
- [withEndpointProxySupport](/reference/api/typescript/aspire.hosting/withendpointproxysupport.md) -- `method` -- Configures endpoint proxy support
- [withEntrypoint](/reference/api/typescript/aspire.hosting/withentrypoint.md) -- `method` -- Sets the container entrypoint
- [withEnvironment](/reference/api/typescript/aspire.hosting/withenvironment.md) -- `method` -- Sets an environment variable
- [withEnvironmentCallback](/reference/api/typescript/aspire.hosting/withenvironmentcallback.md) -- `method` -- Sets environment variables via callback
- [withEnvironmentVariablesConfig](/reference/api/typescript/aspire.hosting/withenvironmentvariablesconfig.md) -- `method` -- Adds an environment variables configuration gatherer
- [withExecutableCommand](/reference/api/typescript/aspire.hosting/withexecutablecommand.md) -- `method` -- Sets the executable command
- [withExplicitStart](/reference/api/typescript/aspire.hosting/withexplicitstart.md) -- `method` -- Prevents resource from starting automatically
- [withExternalHttpEndpoints](/reference/api/typescript/aspire.hosting/withexternalhttpendpoints.md) -- `method` -- Makes HTTP endpoints externally accessible
- [withHealthCheck](/reference/api/typescript/aspire.hosting/withhealthcheck.md) -- `method` -- Adds a health check by key
- [withHttpCommand](/reference/api/typescript/aspire.hosting/withhttpcommand.md) -- `method` -- Adds an HTTP resource command
- [withHttpEndpoint](/reference/api/typescript/aspire.hosting/withhttpendpoint.md) -- `method` -- Adds an HTTP endpoint
- [withHttpEndpointCallback](/reference/api/typescript/aspire.hosting/withhttpendpointcallback.md) -- `method` -- Updates an HTTP endpoint via callback
- [withHttpHealthCheck](/reference/api/typescript/aspire.hosting/withhttphealthcheck.md) -- `method` -- Adds an HTTP health check to the external service
- [withHttpHealthCheck](/reference/api/typescript/aspire.hosting/withhttphealthcheck.md) -- `method` -- Adds an HTTP health check
- [withHttpProbe](/reference/api/typescript/aspire.hosting/withhttpprobe.md) -- `method` -- Adds an HTTP health probe to the resource
- [withHttpsCertificateConfig](/reference/api/typescript/aspire.hosting/withhttpscertificateconfig.md) -- `method` -- Adds an HTTPS certificate configuration gatherer
- [withHttpsDeveloperCertificate](/reference/api/typescript/aspire.hosting/withhttpsdevelopercertificate.md) -- `method` -- Configures HTTPS with a developer certificate
- [withHttpsEndpoint](/reference/api/typescript/aspire.hosting/withhttpsendpoint.md) -- `method` -- Adds an HTTPS endpoint
- [withHttpsEndpointCallback](/reference/api/typescript/aspire.hosting/withhttpsendpointcallback.md) -- `method` -- Updates an HTTPS endpoint via callback
- [withIconName](/reference/api/typescript/aspire.hosting/withiconname.md) -- `method` -- Sets the icon for the resource
- [withImage](/reference/api/typescript/aspire.hosting/withimage.md) -- `method` -- Sets the container image
- [withImagePullPolicy](/reference/api/typescript/aspire.hosting/withimagepullpolicy.md) -- `method` -- Sets the container image pull policy
- [withImagePushOptions](/reference/api/typescript/aspire.hosting/withimagepushoptions.md) -- `method` -- Sets image push options via callback
- [withImageRegistry](/reference/api/typescript/aspire.hosting/withimageregistry.md) -- `method` -- Sets the container image registry
- [withImageSHA256](/reference/api/typescript/aspire.hosting/withimagesha256.md) -- `method` -- Sets the image SHA256 digest
- [withImageTag](/reference/api/typescript/aspire.hosting/withimagetag.md) -- `method` -- Sets the container image tag
- [withLifetime](/reference/api/typescript/aspire.hosting/withlifetime.md) -- `method` -- Sets the lifetime behavior of the container resource
- [withMcpServer](/reference/api/typescript/aspire.hosting/withmcpserver.md) -- `method` -- Configures an MCP server endpoint on the resource
- [withOtlpExporter](/reference/api/typescript/aspire.hosting/withotlpexporter.md) -- `method` -- Configures OTLP telemetry export
- [withoutHttpsCertificate](/reference/api/typescript/aspire.hosting/withouthttpscertificate.md) -- `method` -- Removes HTTPS certificate configuration
- [withParentRelationship](/reference/api/typescript/aspire.hosting/withparentrelationship.md) -- `method` -- Sets the parent relationship
- [withPipelineConfiguration](/reference/api/typescript/aspire.hosting/withpipelineconfiguration.md) -- `method` -- Configures pipeline step dependencies via a callback
- [withPipelineStepFactory](/reference/api/typescript/aspire.hosting/withpipelinestepfactory.md) -- `method` -- Adds a pipeline step to the resource
- [withReference](/reference/api/typescript/aspire.hosting/withreference.md) -- `method` -- Adds a reference to another resource
- [withReferenceEnvironment](/reference/api/typescript/aspire.hosting/withreferenceenvironment.md) -- `method` -- Configures which reference values are injected into environment variables
- [withRelationship](/reference/api/typescript/aspire.hosting/withrelationship.md) -- `method` -- Adds a relationship to another resource
- [withRemoteImageName](/reference/api/typescript/aspire.hosting/withremoteimagename.md) -- `method` -- Sets the remote image name for publishing
- [withRemoteImageTag](/reference/api/typescript/aspire.hosting/withremoteimagetag.md) -- `method` -- Sets the remote image tag for publishing
- [withReplicas](/reference/api/typescript/aspire.hosting/withreplicas.md) -- `method` -- Sets the number of replicas
- [withRequiredCommand](/reference/api/typescript/aspire.hosting/withrequiredcommand.md) -- `method` -- Adds a required command dependency
- [withToolIgnoreExistingFeeds](/reference/api/typescript/aspire.hosting/withtoolignoreexistingfeeds.md) -- `method` -- Ignores existing NuGet feeds
- [withToolIgnoreFailedSources](/reference/api/typescript/aspire.hosting/withtoolignorefailedsources.md) -- `method` -- Ignores failed NuGet sources
- [withToolPackage](/reference/api/typescript/aspire.hosting/withtoolpackage.md) -- `method` -- Sets the tool package ID
- [withToolPrerelease](/reference/api/typescript/aspire.hosting/withtoolprerelease.md) -- `method` -- Allows prerelease tool versions
- [withToolSource](/reference/api/typescript/aspire.hosting/withtoolsource.md) -- `method` -- Adds a NuGet source for the tool
- [withToolVersion](/reference/api/typescript/aspire.hosting/withtoolversion.md) -- `method` -- Sets the tool version
- [withUrl](/reference/api/typescript/aspire.hosting/withurl.md) -- `method` -- Adds or modifies displayed URLs
- [withUrlForEndpoint](/reference/api/typescript/aspire.hosting/withurlforendpoint.md) -- `method` -- Customizes the URL for a specific endpoint via callback
- [withUrls](/reference/api/typescript/aspire.hosting/withurls.md) -- `method` -- Customizes displayed URLs via callback
- [withVolume](/reference/api/typescript/aspire.hosting/withvolume.md) -- `method` -- Adds a volume
- [withWorkingDirectory](/reference/api/typescript/aspire.hosting/withworkingdirectory.md) -- `method` -- Sets the executable working directory
- [workDir](/reference/api/typescript/aspire.hosting/workdir.md) -- `method` -- Adds a WORKDIR statement to a Dockerfile stage

## Enums

- [CertificateTrustScope](/reference/api/typescript/aspire.hosting/certificatetrustscope.md) -- `enum` - 4 values
- [CommandResultFormat](/reference/api/typescript/aspire.hosting/commandresultformat.md) -- `enum` - 3 values
- [ContainerLifetime](/reference/api/typescript/aspire.hosting/containerlifetime.md) -- `enum` - 2 values
- [DistributedApplicationOperation](/reference/api/typescript/aspire.hosting/distributedapplicationoperation.md) -- `enum` - 2 values
- [EndpointProperty](/reference/api/typescript/aspire.hosting/endpointproperty.md) -- `enum` - 8 values
- [HttpCommandResultMode](/reference/api/typescript/aspire.hosting/httpcommandresultmode.md) -- `enum` - 4 values
- [IconVariant](/reference/api/typescript/aspire.hosting/iconvariant.md) -- `enum` - 2 values
- [ImagePullPolicy](/reference/api/typescript/aspire.hosting/imagepullpolicy.md) -- `enum` - 4 values
- [OtlpProtocol](/reference/api/typescript/aspire.hosting/otlpprotocol.md) -- `enum` - 3 values
- [ProbeType](/reference/api/typescript/aspire.hosting/probetype.md) -- `enum` - 3 values
- [UrlDisplayLocation](/reference/api/typescript/aspire.hosting/urldisplaylocation.md) -- `enum` - 2 values
- [WaitBehavior](/reference/api/typescript/aspire.hosting/waitbehavior.md) -- `enum` - 2 values