# Aspire.Hosting

- Module: `Aspire.Hosting`
- Version: `13.2.0`
- Source: [GitHub](https://github.com/microsoft/aspire)
- Functions: `168`
- Types: `79`

## Types

- [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
- [CancellationToken](/reference/api/typescript/aspire.hosting/cancellationtoken.md) -- `handle` - 0 members
- [CommandLineArgsCallbackContext](/reference/api/typescript/aspire.hosting/commandlineargscallbackcontext.md) -- `handle` - 7 members
- [CommandOptions](/reference/api/typescript/aspire.hosting/commandoptions.md) -- `type` - 7 fields
- [ConnectionStringAvailableEvent](/reference/api/typescript/aspire.hosting/connectionstringavailableevent.md) -- `handle` - 2 members
- [ConnectionStringResource](/reference/api/typescript/aspire.hosting/connectionstringresource.md) -- `handle` - 0 members
- [ContainerRegistryResource](/reference/api/typescript/aspire.hosting/containerregistryresource.md) -- `handle` - 0 members
- [ContainerResource](/reference/api/typescript/aspire.hosting/containerresource.md) -- `handle` - 18 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
- [DotnetToolResource](/reference/api/typescript/aspire.hosting/dotnettoolresource.md) -- `handle` - 6 members
- [EndpointReference](/reference/api/typescript/aspire.hosting/endpointreference.md) -- `handle` - 16 members
- [EndpointReferenceExpression](/reference/api/typescript/aspire.hosting/endpointreferenceexpression.md) -- `handle` - 3 members
- [EnvironmentCallbackContext](/reference/api/typescript/aspire.hosting/environmentcallbackcontext.md) -- `handle` - 6 members
- [ExecutableResource](/reference/api/typescript/aspire.hosting/executableresource.md) -- `handle` - 4 members
- [ExecuteCommandContext](/reference/api/typescript/aspire.hosting/executecommandcontext.md) -- `handle` - 6 members
- [ExecuteCommandResult](/reference/api/typescript/aspire.hosting/executecommandresult.md) -- `type` - 3 fields
- [ExternalServiceResource](/reference/api/typescript/aspire.hosting/externalserviceresource.md) -- `handle` - 1 members
- [IConfiguration](/reference/api/typescript/aspire.hosting/iconfiguration.md) -- `interface` - 5 members
- [IConfigurationSection](/reference/api/typescript/aspire.hosting/iconfigurationsection.md) -- `interface` - 0 members
- [IDistributedApplicationBuilder](/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder.md) -- `interface` - 28 members
- [IDistributedApplicationEvent](/reference/api/typescript/aspire.hosting/idistributedapplicationevent.md) -- `interface` - 0 members
- [IDistributedApplicationEventing](/reference/api/typescript/aspire.hosting/idistributedapplicationeventing.md) -- `interface` - 1 members
- [IDistributedApplicationResourceEvent](/reference/api/typescript/aspire.hosting/idistributedapplicationresourceevent.md) -- `interface` - 0 members
- [IHostEnvironment](/reference/api/typescript/aspire.hosting/ihostenvironment.md) -- `interface` - 4 members
- [ILogger](/reference/api/typescript/aspire.hosting/ilogger.md) -- `interface` - 5 members
- [ILoggerFactory](/reference/api/typescript/aspire.hosting/iloggerfactory.md) -- `interface` - 1 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` - 24 members
- [IResourceWithArgs](/reference/api/typescript/aspire.hosting/iresourcewithargs.md) -- `interface` - 3 members
- [IResourceWithConnectionString](/reference/api/typescript/aspire.hosting/iresourcewithconnectionstring.md) -- `interface` - 4 members
- [IResourceWithContainerFiles](/reference/api/typescript/aspire.hosting/iresourcewithcontainerfiles.md) -- `interface` - 2 members
- [IResourceWithEndpoints](/reference/api/typescript/aspire.hosting/iresourcewithendpoints.md) -- `interface` - 11 members
- [IResourceWithEnvironment](/reference/api/typescript/aspire.hosting/iresourcewithenvironment.md) -- `interface` - 15 members
- [IResourceWithParent](/reference/api/typescript/aspire.hosting/iresourcewithparent.md) -- `interface` - 0 members
- [IResourceWithWaitSupport](/reference/api/typescript/aspire.hosting/iresourcewithwaitsupport.md) -- `interface` - 5 members
- [IServiceProvider](/reference/api/typescript/aspire.hosting/iserviceprovider.md) -- `interface` - 6 members
- [IUserSecretsManager](/reference/api/typescript/aspire.hosting/iusersecretsmanager.md) -- `interface` - 5 members
- [ParameterResource](/reference/api/typescript/aspire.hosting/parameterresource.md) -- `handle` - 1 members
- [PipelineConfigurationContext](/reference/api/typescript/aspire.hosting/pipelineconfigurationcontext.md) -- `handle` - 7 members
- [PipelineContext](/reference/api/typescript/aspire.hosting/pipelinecontext.md) -- `handle` - 7 members
- [PipelineStep](/reference/api/typescript/aspire.hosting/pipelinestep.md) -- `handle` - 14 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
- [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` - 6 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
- [addConnectionStringBuilder](/reference/api/typescript/aspire.hosting/addconnectionstringbuilder.md) -- `method` -- Adds a connection string with a builder callback
- [addConnectionStringExpression](/reference/api/typescript/aspire.hosting/addconnectionstringexpression.md) -- `method` -- Adds a connection string with a reference expression
- [addContainer](/reference/api/typescript/aspire.hosting/addcontainer.md) -- `method` -- Adds a container resource
- [addContainerRegistry](/reference/api/typescript/aspire.hosting/addcontainerregistry.md) -- `method` -- Adds a container registry resource
- [addContainerRegistryFromString](/reference/api/typescript/aspire.hosting/addcontainerregistryfromstring.md) -- `method` -- Adds a container registry with string endpoint
- [addCSharpApp](/reference/api/typescript/aspire.hosting/addcsharpapp.md) -- `method` -- Adds a C# application resource
- [addCSharpAppWithOptions](/reference/api/typescript/aspire.hosting/addcsharpappwithoptions.md) -- `method` -- Adds a C# application resource with configuration options
- [addDockerfile](/reference/api/typescript/aspire.hosting/adddockerfile.md) -- `method` -- Adds a container resource built from a Dockerfile
- [addDotnetTool](/reference/api/typescript/aspire.hosting/adddotnettool.md) -- `method` -- Adds a .NET tool resource
- [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
- [addExternalServiceParameter](/reference/api/typescript/aspire.hosting/addexternalserviceparameter.md) -- `method` -- Adds an external service with a parameter URL
- [addExternalServiceUri](/reference/api/typescript/aspire.hosting/addexternalserviceuri.md) -- `method` -- Adds an external service with a URI
- [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
- [addParameterWithValue](/reference/api/typescript/aspire.hosting/addparameterwithvalue.md) -- `method` -- Adds a parameter with a default value
- [addProject](/reference/api/typescript/aspire.hosting/addproject.md) -- `method` -- Adds a .NET project resource
- [addProjectWithOptions](/reference/api/typescript/aspire.hosting/addprojectwithoptions.md) -- `method` -- Adds a project resource with configuration options
- [asHttp2Service](/reference/api/typescript/aspire.hosting/ashttp2service.md) -- `method` -- Configures resource for HTTP/2
- [clearContainerFilesSources](/reference/api/typescript/aspire.hosting/clearcontainerfilessources.md) -- `method` -- Clears all container file sources
- [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
- [createBuilder](/reference/api/typescript/aspire.hosting/createbuilder.md) -- `method` -- Creates a new distributed application builder
- [createBuilderWithOptions](/reference/api/typescript/aspire.hosting/createbuilderwithoptions.md) -- `method` -- Creates builder with options
- [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
- [disableForwardedHeaders](/reference/api/typescript/aspire.hosting/disableforwardedheaders.md) -- `method` -- Disables forwarded headers for the project
- [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
- [findResourceByName](/reference/api/typescript/aspire.hosting/findresourcebyname.md) -- `method` -- Finds a resource by name
- [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
- [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
- [onBeforeResourceStarted](/reference/api/typescript/aspire.hosting/onbeforeresourcestarted.md) -- `method` -- Subscribes to the BeforeResourceStarted 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 the executable as a Docker container
- [publishAsDockerFile](/reference/api/typescript/aspire.hosting/publishasdockerfile.md) -- `method` -- Publishes a project as a Docker file with optional container configuration
- [publishAsDockerFileWithConfigure](/reference/api/typescript/aspire.hosting/publishasdockerfilewithconfigure.md) -- `method` -- Publishes an executable 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
- [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
- [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
- [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
- [waitForStartWithBehavior](/reference/api/typescript/aspire.hosting/waitforstartwithbehavior.md) -- `method` -- Waits for another resource to start with specific behavior
- [waitForWithBehavior](/reference/api/typescript/aspire.hosting/waitforwithbehavior.md) -- `method` -- Waits for another resource with specific behavior
- [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
- [withArgsCallbackAsync](/reference/api/typescript/aspire.hosting/withargscallbackasync.md) -- `method` -- Sets command-line arguments via async callback
- [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 parameter resource
- [withBuildSecret](/reference/api/typescript/aspire.hosting/withbuildsecret.md) -- `method` -- Adds a build secret from a parameter resource
- [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 reference expression
- [withConnectionPropertyValue](/reference/api/typescript/aspire.hosting/withconnectionpropertyvalue.md) -- `method` -- Adds a connection property with a string value
- [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
- [withEndpoint](/reference/api/typescript/aspire.hosting/withendpoint.md) -- `method` -- Adds a network endpoint
- [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 on the resource
- [withEnvironmentCallback](/reference/api/typescript/aspire.hosting/withenvironmentcallback.md) -- `method` -- Sets environment variables via callback
- [withEnvironmentConnectionString](/reference/api/typescript/aspire.hosting/withenvironmentconnectionstring.md) -- `method` -- Sets an environment variable from a connection string resource
- [withEnvironmentEndpoint](/reference/api/typescript/aspire.hosting/withenvironmentendpoint.md) -- `method` -- Sets an environment variable from an endpoint reference
- [withEnvironmentParameter](/reference/api/typescript/aspire.hosting/withenvironmentparameter.md) -- `method` -- Sets an environment variable from a parameter resource
- [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
- [withExternalServiceHttpHealthCheck](/reference/api/typescript/aspire.hosting/withexternalservicehttphealthcheck.md) -- `method` -- Adds an HTTP health check to an external service
- [withHealthCheck](/reference/api/typescript/aspire.hosting/withhealthcheck.md) -- `method` -- Adds a health check by key
- [withHttpEndpoint](/reference/api/typescript/aspire.hosting/withhttpendpoint.md) -- `method` -- Adds an HTTP endpoint
- [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
- [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
- [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
- [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
- [withOtlpExporterProtocol](/reference/api/typescript/aspire.hosting/withotlpexporterprotocol.md) -- `method` -- Configures OTLP telemetry export with specific protocol
- [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
- [withPipelineConfigurationAsync](/reference/api/typescript/aspire.hosting/withpipelineconfigurationasync.md) -- `method` -- Configures pipeline step dependencies via an async 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
- [withReferenceEndpoint](/reference/api/typescript/aspire.hosting/withreferenceendpoint.md) -- `method` -- Adds a reference to an endpoint
- [withReferenceExternalService](/reference/api/typescript/aspire.hosting/withreferenceexternalservice.md) -- `method` -- Adds a reference to an external service
- [withReferenceUri](/reference/api/typescript/aspire.hosting/withreferenceuri.md) -- `method` -- Adds a reference to a URI
- [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
- [withUrlExpression](/reference/api/typescript/aspire.hosting/withurlexpression.md) -- `method` -- Adds a URL using a reference expression
- [withUrlForEndpoint](/reference/api/typescript/aspire.hosting/withurlforendpoint.md) -- `method` -- Customizes the URL for a specific endpoint via callback
- [withUrlForEndpointFactory](/reference/api/typescript/aspire.hosting/withurlforendpointfactory.md) -- `method` -- Adds a URL for a specific endpoint via factory callback
- [withUrlsCallback](/reference/api/typescript/aspire.hosting/withurlscallback.md) -- `method` -- Customizes displayed URLs via callback
- [withUrlsCallbackAsync](/reference/api/typescript/aspire.hosting/withurlscallbackasync.md) -- `method` -- Customizes displayed URLs via async 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

## Enums

- [CertificateTrustScope](/reference/api/typescript/aspire.hosting/certificatetrustscope.md) -- `enum` - 4 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
- [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
- [ProtocolType](/reference/api/typescript/aspire.hosting/protocoltype.md) -- `enum` - 25 values
- [UrlDisplayLocation](/reference/api/typescript/aspire.hosting/urldisplaylocation.md) -- `enum` - 2 values
- [WaitBehavior](/reference/api/typescript/aspire.hosting/waitbehavior.md) -- `enum` - 2 values