Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

Aspire.Hosting

Official
📦 Aspire.Hostingv17.0.0
Import pathapphost/modules/aspire
247Functions
160Types

Handles

handleAfterPublishEvent2 members
handleAfterResourcesCreatedEvent2 members
interfaceAspireStore2 members
handleBeforePublishEvent2 members
handleBeforeResourceStartedEvent2 members
handleBeforeStartEvent2 members
handleCommandLineArgsCallbackContext4 members
handleCommandLineArgsEditor2 members
interfaceComputeEnvironmentResourcemarker
interfaceConfiguration5 members
interfaceConfigurationSectionmarker
handleConnectionStringAvailableEvent2 members
handleContainerBuildOptionsCallbackContext11 members
handleContainerFileSystemCallbackContext5 members
handleContainerFileSystemItem
handleContainerImagePushOptions2 members
handleContainerImagePushOptionsCallbackContext3 members
handleContainerImageReference2 members
handleContainerMountAnnotation4 members
handleContainerPortReference2 members
handleContainerRegistryResource
handleContainerResource22 members
handleCSharpAppResource
handleDistributedApplication1 members
interfaceDistributedApplicationBuilder30 members
interfaceDistributedApplicationEventmarker
interfaceDistributedApplicationEventing1 members
handleDistributedApplicationEventSubscription
handleDistributedApplicationExecutionContext7 members
handleDistributedApplicationExecutionContextOptions
handleDistributedApplicationModel2 members
interfaceDistributedApplicationPipeline3 members
interfaceDistributedApplicationResourceEventmarker
handleDistributedApplicationResourceEventSubscription
handleDockerfileBuilder3 members
handleDockerfileBuilderCallbackContext4 members
handleDockerfileFactoryContext1 members
handleDockerfileStage14 members
interfaceDotnetProgramResourcemarker
handleDotnetToolResource6 members
handleEndpointReference20 members
handleEndpointReferenceExpression3 members
handleEndpointUpdateContext11 members
handleEnvironmentCallbackContext4 members
handleEnvironmentEditor1 members
handleEventingSubscriberRegistrationContext6 members
handleExecutableResource5 members
handleExecuteCommandContext5 members
interfaceExecutionConfigurationBuilder5 members
interfaceExecutionConfigurationResult2 members
interfaceExpressionValuemarker
handleExternalServiceResource1 members
interfaceHostEnvironment4 members
handleHttpCommandPrepareRequestContext4 members
handleHttpsCertificateConfigurationCallbackAnnotationContext9 members
handleHttpsEndpointUpdateCallbackContext4 members
handleIComputeResource4 members
handleIContainerFilesDestinationResource1 members
handleInitializeResourceEvent5 members
handleInputsDialogValidationContext4 members
handleInputsInteractionResult2 members
handleInteractionInputBuilder4 members
handleInteractionInputCollection5 members
handleInteractionInputLoadContext2 members
handleInteractionLoadingInput3 members
interfaceInteractionService13 members
handleLogFacade4 members
interfaceLogger5 members
interfaceLoggerFactory1 members
handleParameterResource6 members
handlePipelineConfigurationContext3 members
handlePipelineContext6 members
handlePipelineEditor2 members
handlePipelineStep8 members
handlePipelineStepContext8 members
handlePipelineStepFactoryContext2 members
handlePipelineSummary2 members
handleProgressContext1 members
handleProjectResource5 members
handleProjectResourceOptions3 members
handleReferenceExpressionBuilder5 members
interfaceReportingStep6 members
interfaceReportingTask4 members
handleRequiredCommandValidationContext5 members
handleRequiredCommandValidationResult2 members
interfaceResourcemarker42 members
handleResourceCommandService1 members
handleResourceEndpointsAllocatedEvent2 members
handleResourceLoggerService2 members
handleResourceNotificationService6 members
handleResourceReadyEvent2 members
handleResourceStoppedEvent2 members
handleResourceUrlsCallbackContext5 members
handleResourceUrlsEditor3 members
interfaceResourceWithArgsmarker4 members
interfaceResourceWithConnectionString3 members
interfaceResourceWithContainerFiles2 members
interfaceResourceWithEndpointsmarker15 members
interfaceResourceWithEnvironmentmarker10 members
interfaceResourceWithParentmarker
interfaceResourceWithWaitSupportmarker3 members
interfaceServiceProvider9 members
handleUpdateCommandStateContext2 members
interfaceUserSecretsManager6 members

DTOs

Enums

Functions

ContainerResource

methodPublishAsConnectionStringbuilder
Changes the resource to be published as a connection string reference in the manifest.
PublishAsConnectionString() ContainerResource
methodPublishAsContainerbuilder
Changes the resource to be published as a container in the manifest.
PublishAsContainer() ContainerResource
methodWithBindMountbuilder
Adds a bind mount to a container resource.
WithBindMount(source string, target string, options ...*WithBindMountOptions) ContainerResource
methodWithBuildArgbuilder
Adds a build argument when the container is built from a Dockerfile.
WithBuildArg(name string, value any) ContainerResource
methodWithBuildSecretbuilder
Adds a secret build argument when the container is built from a Dockerfile.
WithBuildSecret(name string, value ParameterResource) ContainerResource
methodWithContainerCertificatePathsbuilder
Adds container certificate path overrides used for certificate trust at run time.
WithContainerCertificatePaths(options ...*WithContainerCertificatePathsOptions) ContainerResource
methodWithContainerFilesbuilder
Creates or updates files and folders in a container by copying them from a source path on the host.
WithContainerFiles(destinationPath string, sourcePath string, options ...*ContainerFilesOptions) ContainerResource
methodWithContainerFilesCallbackbuilder
Creates or updates files and/or folders at the destination path in the container using entries produced by a callback.
WithContainerFilesCallback(destinationPath string, callback func(arg1 ContainerFileSystemCallbackContext, arg2 *CancellationToken) []ContainerFileSystemItem, options ...*ContainerFilesOptions) ContainerResource
methodWithContainerNamebuilder
Overrides the default container name for this resource. By default Aspire generates a unique container name based on the resource name and a random postfix (or a postfix based on a hash of the AppHost project path for persistent container resources). This method allows you to override that behavior with a custom name, but could lead to naming conflicts if the specified name is not unique.
WithContainerName(name string) ContainerResource
methodWithContainerNetworkAliasbuilder
Adds a network alias to container resource.
WithContainerNetworkAlias(alias string) ContainerResource
methodWithContainerRuntimeArgsbuilder
Adds a callback to be executed with a list of arguments to add to the container runtime run command when a container resource is started.
WithContainerRuntimeArgs(args []string) ContainerResource
methodWithDockerfilebuilder
Causes Aspire to build the specified container image from a Dockerfile.
WithDockerfile(contextPath string, options ...*WithDockerfileOptions) ContainerResource
methodWithDockerfileBuilderbuilder
Configures the resource to use a programmatically generated Dockerfile
WithDockerfileBuilder(contextPath string, callback func(arg DockerfileBuilderCallbackContext), options ...*WithDockerfileBuilderOptions) ContainerResource
methodWithDockerfileFactorybuilder
Builds the specified container image from a Dockerfile generated by an asynchronous factory function.
WithDockerfileFactory(contextPath string, dockerfileFactory func(arg DockerfileFactoryContext) string, options ...*WithDockerfileFactoryOptions) ContainerResource
methodWithEntrypointbuilder
Sets the Entrypoint for the container.
WithEntrypoint(entrypoint string) ContainerResource
methodWithImagebuilder
Allows overriding the image on a container.
WithImage(image string, options ...*WithImageOptions) ContainerResource
methodWithImagePullPolicybuilder
Sets the pull policy for the container resource.
WithImagePullPolicy(pullPolicy ImagePullPolicy) ContainerResource
methodWithImageRegistrybuilder
Allows overriding the image registry on a container.
WithImageRegistry(registry string) ContainerResource
methodWithImageSHA256builder
Allows setting the image to a specific sha256 on a container.
WithImageSHA256(sha256 string) ContainerResource
methodWithImageTagbuilder
Allows overriding the image tag on a container.
WithImageTag(tag string) ContainerResource
methodWithLifetimebuilder
Sets the lifetime behavior of the container resource.
WithLifetime(lifetime ContainerLifetime) ContainerResource
methodWithVolumebuilder
Adds a volume to a container resource.
WithVolume(target string, options ...*WithVolumeOptions) ContainerResource

DistributedApplicationBuilder

methodAddConnectionStringbuilder
Adds a connection string resource
AddConnectionString(name string, options ...*AddConnectionStringOptions) ResourceWithConnectionString
methodAddContainerbuilder
Adds a container resource to the application.
AddContainer(name string, image any) ContainerResource
methodAddContainerRegistrybuilder
Adds a container registry resource
AddContainerRegistry(name string, endpoint any, options ...*AddContainerRegistryOptions) ContainerRegistryResource
methodAddCSharpAppbuilder
Adds a C# application resource
AddCSharpApp(name string, path string, options ...*AddCSharpAppOptions) CSharpAppResource
methodAddDockerfilebuilder
Adds a Dockerfile to the application model that can be treated like a container resource.
AddDockerfile(name string, contextPath string, options ...*AddDockerfileOptions) ContainerResource
methodAddDockerfileBuilderbuilder
Adds a container resource built from a programmatically generated Dockerfile
AddDockerfileBuilder(name string, contextPath string, callback func(arg DockerfileBuilderCallbackContext), options ...*AddDockerfileBuilderOptions) ContainerResource
methodAddDockerfileFactorybuilder
Adds a Dockerfile to the application model that can be treated like a container resource, with the Dockerfile content generated by an asynchronous factory function.
AddDockerfileFactory(name string, contextPath string, dockerfileFactory func(arg DockerfileFactoryContext) string, options ...*AddDockerfileFactoryOptions) ContainerResource
methodAddDotnetToolbuilder
Adds a .NET tool resource to the application model.
AddDotnetTool(name string, packageId string) DotnetToolResource
methodAddEventingSubscriber
Adds an ATS-friendly eventing subscriber callback to the distributed-application builder.
AddEventingSubscriber(subscribe func(arg EventingSubscriberRegistrationContext)) error
methodAddExecutablebuilder
Adds an executable resource to the application model.
AddExecutable(name string, command string, workingDirectory string, args []string) ExecutableResource
methodAddExternalServicebuilder
Adds an external service resource
AddExternalService(name string, url any) ExternalServiceResource
methodAddHealthCheck
Adds a custom health check callback to the distributed-application builder.
AddHealthCheck(name string, check func(...any) *HealthCheckResult) error
methodAddParameterbuilder
Adds a parameter resource
AddParameter(name string, options ...*AddParameterOptions) ParameterResource
methodAddParameterFromConfigurationbuilder
Adds a parameter resource to the application, with a value coming from configuration.
AddParameterFromConfiguration(name string, configurationKey string, options ...*AddParameterFromConfigurationOptions) ParameterResource
methodAddParameterWithGeneratedValuebuilder
Adds a parameter with a generated default value
AddParameterWithGeneratedValue(name string, value *GenerateParameterDefault, options ...*AddParameterWithGeneratedValueOptions) ParameterResource
methodAddProjectbuilder
Adds a .NET project resource
AddProject(name string, projectPath string, options ...*AddProjectOptions) ProjectResource
methodGetConfiguration
Gets the application configuration.
GetConfiguration() Configuration
methodSubscribeAfterPublish
Subscribes to the AfterPublish event, which fires after the application is published.
SubscribeAfterPublish(callback func(arg AfterPublishEvent)) DistributedApplicationEventSubscription
methodSubscribeAfterResourcesCreated
Subscribes to the AfterResourcesCreated event, which fires after all resources are created.
SubscribeAfterResourcesCreated(callback func(arg AfterResourcesCreatedEvent)) DistributedApplicationEventSubscription
methodSubscribeBeforePublish
Subscribes to the BeforePublish event, which fires before the application is published.
SubscribeBeforePublish(callback func(arg BeforePublishEvent)) DistributedApplicationEventSubscription
methodSubscribeBeforeStart
Subscribes to the BeforeStart event, which fires before the application starts.
SubscribeBeforeStart(callback func(arg BeforeStartEvent)) DistributedApplicationEventSubscription
methodTryAddEventingSubscriber
Attempts to add an ATS-friendly eventing subscriber callback to the distributed-application builder.
TryAddEventingSubscriber(subscribe func(arg EventingSubscriberRegistrationContext)) error
methodWithOutputDiffing
Adds an opt-in target that checks for stale generated pipeline output.
WithOutputDiffing(options ...*WithOutputDiffingOptions) DistributedApplicationBuilder

DockerfileStage

methodAddContainerFiles
Adds COPY --from statements for published container files
AddContainerFiles(resource Resource, rootDestinationPath string, options ...*AddContainerFilesOptions) DockerfileStage
methodArg
Adds an ARG statement to a Dockerfile stage
Arg(name string, options ...*ArgOptions) DockerfileStage
methodCmd
Adds a CMD statement to a Dockerfile stage
Cmd(command []string) DockerfileStage
methodComment
Adds a comment to a Dockerfile stage
Comment(comment string) DockerfileStage
methodCopy
Adds a COPY statement to a Dockerfile stage
Copy(source string, destination string, options ...*CopyOptions) DockerfileStage
methodCopyFrom
Adds a COPY --from statement to a Dockerfile stage
CopyFrom(from string, source string, destination string, options ...*CopyFromOptions) DockerfileStage
methodEmptyLine
Adds an empty line to a Dockerfile stage
EmptyLine() DockerfileStage
methodEntrypoint
Adds an ENTRYPOINT statement to a Dockerfile stage
Entrypoint(command []string) DockerfileStage
methodEnv
Adds an ENV statement to a Dockerfile stage
Env(name string, value string) DockerfileStage
methodExpose
Adds an EXPOSE statement to a Dockerfile stage
Expose(port float64) DockerfileStage
methodRun
Adds a RUN statement to a Dockerfile stage
Run(command string) DockerfileStage
methodRunWithMounts
Adds a RUN statement with mounts to a Dockerfile stage
RunWithMounts(command string, mounts []string) DockerfileStage
methodUser
Adds a USER statement to a Dockerfile stage
User(user string) DockerfileStage
methodWorkDir
Adds a WORKDIR statement to a Dockerfile stage
WorkDir(path string) DockerfileStage

InteractionService

methodCreateBooleanInput
Creates a boolean (checkbox) input.
CreateBooleanInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder
methodCreateChoiceInput
Creates a choice input that selects from a list of options.
CreateChoiceInput(name string, options ...*CreateChoiceInputOptions) InteractionInputBuilder
methodCreateFileInput
Creates a file input.
CreateFileInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder
methodCreateNumberInput
Creates a numeric input.
CreateNumberInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder
methodCreateSecretInput
Creates a secret (masked) text input.
CreateSecretInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder
methodCreateTextInput
Creates a single-line text input.
CreateTextInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder
methodIsAvailable
Gets a value indicating whether the interaction service is available to prompt the user.
IsAvailable() (bool, error)
methodPromptConfirmation
Prompts the user for confirmation with an OK/Cancel dialog.
PromptConfirmation(title string, message string, options ...*PromptConfirmationOptions) (*BoolInteractionResult, error)
methodPromptInput
Prompts the user for a single input.
PromptInput(title string, message string, input InteractionInputBuilder, options ...*PromptInputOptions) (*InputInteractionResult, error)
methodPromptInputs
Prompts the user for multiple inputs.
PromptInputs(title string, message string, inputs []InteractionInputBuilder, options ...*PromptInputsOptions) InputsInteractionResult
methodPromptMessageBox
Prompts the user with a message box dialog.
PromptMessageBox(title string, message string, options ...*PromptMessageBoxOptions) (*BoolInteractionResult, error)
methodPromptNotification
Prompts the user with a notification.
PromptNotification(title string, message string, options ...*PromptNotificationOptions) (*BoolInteractionResult, error)
methodPromptProgress
Displays a progress dialog with an indeterminate progress indicator.
PromptProgress(message string, options ...*PromptProgressOptions) (*BoolInteractionResult, error)

Resource

methodCreateExecutionConfiguration
Creates an execution configuration builder for the specified resource.
CreateExecutionConfiguration() ExecutionConfigurationBuilder
methodExcludeFromManifestbuilder
Excludes a resource from being published to the manifest.
ExcludeFromManifest() Resource
methodExcludeFromMcpbuilder
Exclude the resource from MCP operations using the Aspire MCP server. The resource is excluded from results that return resources, console logs and telemetry.
ExcludeFromMcp() Resource
methodGetResourceName
Gets the name of the resource from a builder.
GetResourceName() (string, error)
methodGetSerializedAnnotation
Gets a serialized ATS annotation payload from a resource.
GetSerializedAnnotation(annotationId string) (string, error)
methodHasSerializedAnnotation
Determines whether a resource has a serialized ATS annotation with the specified ID.
HasSerializedAnnotation(annotationId string) (bool, error)
methodOnBeforeResourceStartedbuilder
Subscribes to the BeforeResourceStarted event.
OnBeforeResourceStarted(callback func(arg BeforeResourceStartedEvent)) Resource
methodOnInitializeResourcebuilder
Subscribes to the InitializeResource event.
OnInitializeResource(callback func(arg InitializeResourceEvent)) Resource
methodOnResourceReadybuilder
Subscribes to the ResourceReady event.
OnResourceReady(callback func(arg ResourceReadyEvent)) Resource
methodOnResourceStoppedbuilder
Subscribes to the ResourceStopped event.
OnResourceStopped(callback func(arg ResourceStoppedEvent)) Resource
methodSubscribeHttpsEndpointsUpdatebuilder
Subscribes to the BeforeStartEvent and invokes the specified callback when an HTTPS certificate is determined to be available for the resource. This is used to conditionally update endpoint URI schemes or perform other HTTPS-related configuration at startup.
SubscribeHttpsEndpointsUpdate(callback func(obj HttpsEndpointUpdateCallbackContext)) Resource
methodWithChildRelationshipbuilder
Sets a child relationship
WithChildRelationship(child Resource) Resource
methodWithCommandbuilder
Adds a resource command
WithCommand(name string, displayName string, executeCommand func(arg ExecuteCommandContext) *ExecuteCommandResult, options ...*WithCommandOptions) Resource
methodWithContainerBuildOptionsbuilder
Configures container build options for a compute resource using an async callback.
WithContainerBuildOptions(callback func(arg ContainerBuildOptionsCallbackContext)) Resource
methodWithContainerRegistrybuilder
Configures the resource to use the specified container registry for container image operations.
WithContainerRegistry(registry Resource) Resource
methodWithDisplayOrderbuilder
Sets the default display order of the resource in lists of resources, such as the dashboard's. A saved ordering takes precedence. Repeated calls replace the order.
WithDisplayOrder(order float64) Resource
methodWithDockerfileBaseImagebuilder
Configures custom base images for generated Dockerfiles.
WithDockerfileBaseImage(options ...*WithDockerfileBaseImageOptions) Resource
methodWithExplicitStartbuilder
Prevents resource from starting automatically
WithExplicitStart() Resource
methodWithHealthCheckbuilder
Adds a health check by key
WithHealthCheck(key string) Resource
methodWithHiddenbuilder
Hides the resource from default resource lists
WithHidden() Resource
methodWithHiddenOnCompletionbuilder
Hides the resource from default resource lists after successful completion
WithHiddenOnCompletion(options ...*WithHiddenOnCompletionOptions) Resource
methodWithIconNamebuilder
Specifies the icon to use when displaying the resource in the dashboard.
WithIconName(iconName string, options ...*WithIconNameOptions) Resource
methodWithLifetimeOfbuilder
Configures a resource to match the lifetime of another resource.
WithLifetimeOf(sourceBuilder Resource) Resource
methodWithParentProcessLifetimebuilder
Configures a resource to use a persistent lifetime that ends when a parent process exits.
WithParentProcessLifetime(parentProcessId float64) Resource
methodWithParentRelationshipbuilder
Sets the parent relationship
WithParentRelationship(parent Resource) Resource
methodWithPersistentLifetimebuilder
Configures a resource to use a persistent lifetime.
WithPersistentLifetime() Resource
methodWithPipelineConfigurationbuilder
Registers a callback to be executed during the pipeline configuration phase, allowing modification of step dependencies and relationships.
WithPipelineConfiguration(callback func(obj PipelineConfigurationContext)) Resource
methodWithPipelineStepFactorybuilder
Adds a pipeline step to the resource that will be executed during deployment.
WithPipelineStepFactory(stepName string, callback func(arg PipelineStepContext), options ...*WithPipelineStepFactoryOptions) Resource
methodWithProcessCommandbuilder
Adds a command to the resource that starts a local process when invoked.
WithProcessCommand(commandName string, displayName string, options *ProcessCommandExportOptions) Resource
methodWithProcessCommandFactorybuilder
Adds a command to the resource that starts a local process created by a callback when invoked.
WithProcessCommandFactory(commandName string, displayName string, createProcessSpec func(arg ExecuteCommandContext) *ProcessCommandSpecExportData, options ...*ProcessCommandResultExportOptions) Resource
methodWithRelationshipbuilder
Adds a relationship to another resource using its builder.
WithRelationship(resourceBuilder Resource, type_ string) Resource
methodWithRequiredCommandbuilder
Declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start.
WithRequiredCommand(command string, options ...*WithRequiredCommandOptions) Resource
methodWithRequiredCommandValidationbuilder
Declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start, with custom validation logic.
WithRequiredCommandValidation(command string, validationCallback func(arg RequiredCommandValidationContext) RequiredCommandValidationResult, options ...*WithRequiredCommandValidationOptions) Resource
methodWithResourceTypeDisplayNamebuilder
Overrides the human-readable resource type label.
WithResourceTypeDisplayName(resourceTypeDisplayName string) Resource
methodWithSerializedAnnotation
Stores a serialized ATS annotation payload on a resource, replacing any existing annotation with the same ID.
WithSerializedAnnotation(annotationId string, json string) Resource
methodWithSessionLifetimebuilder
Configures a resource to use a session lifetime.
WithSessionLifetime() Resource
methodWithTagsbuilder
Adds AppHost-defined dashboard tags that users cannot remove. Repeated calls add tags.
WithTags(tags []string) Resource
methodWithTerminalbuilder
Adds an interactive terminal session to a resource with an optional callback to configure its initial dimensions.
WithTerminal(options ...*WithTerminalOptions) Resource
methodWithTraitbuilder
Adds immutable, non-sensitive metadata to a resource. Repeated names add multiple values.
WithTrait(name string, value string) Resource
methodWithUrlbuilder
Adds or modifies displayed URLs
WithUrl(url any, options ...*WithUrlOptions) Resource
methodWithUrlForEndpointbuilder
Registers a callback to update the URL displayed for the endpoint with the specified name.
WithUrlForEndpoint(endpointName string, callback func(obj *ResourceUrlAnnotation)) Resource
methodWithUrlsbuilder
Registers a callback to customize the URLs displayed for the resource.
WithUrls(callback func(obj ResourceUrlsCallbackContext)) Resource

ResourceWithEndpoints

methodAsHttp2Servicebuilder
Configures a resource to mark all endpoints' transport as HTTP/2. This is useful for HTTP/2 services that need prior knowledge.
AsHttp2Service() ResourceWithEndpoints
methodGetEndpoint
Gets an endpoint reference
GetEndpoint(name string) EndpointReference
methodOnResourceEndpointsAllocatedbuilder
Subscribes to the ResourceEndpointsAllocated event.
OnResourceEndpointsAllocated(callback func(arg ResourceEndpointsAllocatedEvent)) ResourceWithEndpoints
methodWithEndpointbuilder
Adds a network endpoint
WithEndpoint(options ...*WithEndpointOptions) ResourceWithEndpoints
methodWithEndpointCallbackbuilder
Updates a named endpoint via callback
WithEndpointCallback(endpointName string, callback func(obj EndpointUpdateContext), options ...*WithEndpointCallbackOptions) ResourceWithEndpoints
methodWithEndpointProxySupportbuilder
Set whether a resource can use proxied endpoints or whether they should be disabled for all endpoints belonging to the resource. If set to false, endpoints belonging to the resource will ignore the configured proxy settings and run proxy-less.
WithEndpointProxySupport(proxyEnabled bool) ResourceWithEndpoints
methodWithExternalHttpEndpointsbuilder
Marks existing http or https endpoints on a resource as external.
WithExternalHttpEndpoints() ResourceWithEndpoints
methodWithHttpCommandbuilder
Adds an HTTP resource command
WithHttpCommand(path string, displayName string, options ...*HttpCommandExportOptions) ResourceWithEndpoints
methodWithHttpEndpointbuilder
Adds an HTTP endpoint
WithHttpEndpoint(options ...*WithHttpEndpointOptions) ResourceWithEndpoints
methodWithHttpEndpointCallbackbuilder
Updates an HTTP endpoint via callback
WithHttpEndpointCallback(callback func(obj EndpointUpdateContext), options ...*WithHttpEndpointCallbackOptions) ResourceWithEndpoints
methodWithHttpHealthCheckbuilder
Adds a health check to the resource which is mapped to a specific endpoint.
WithHttpHealthCheck(options ...*WithHttpHealthCheckOptions) ResourceWithEndpoints
methodWithHttpProbebuilder
Adds an HTTP health probe to the resource
WithHttpProbe(probeType ProbeType, options ...*WithHttpProbeOptions) ResourceWithEndpoints
methodWithHttpsEndpointbuilder
Adds an HTTPS endpoint
WithHttpsEndpoint(options ...*WithHttpsEndpointOptions) ResourceWithEndpoints
methodWithHttpsEndpointCallbackbuilder
Updates an HTTPS endpoint via callback
WithHttpsEndpointCallback(callback func(obj EndpointUpdateContext), options ...*WithHttpsEndpointCallbackOptions) ResourceWithEndpoints
methodWithMcpServerbuilder
Marks the resource as hosting a Model Context Protocol (MCP) server on the specified endpoint.
WithMcpServer(options ...*WithMcpServerOptions) ResourceWithEndpoints

ResourceWithEnvironment

methodWithCertificateTrustScopebuilder
Sets the certificate trust scope
WithCertificateTrustScope(scope CertificateTrustScope) ResourceWithEnvironment
methodWithDeveloperCertificateTrustbuilder
Indicates whether developer certificates should be treated as trusted certificate authorities for the resource at run time. Currently this indicates trust for the ASP.NET Core developer certificate. The developer certificate will only be trusted when running in local development scenarios; in publish mode resources will use their default certificate trust.
WithDeveloperCertificateTrust(trust bool) ResourceWithEnvironment
methodWithEnvironmentbuilder
Sets an environment variable
WithEnvironment(name string, value any) ResourceWithEnvironment
methodWithEnvironmentCallbackbuilder
Allows for the population of environment variables on a resource.
WithEnvironmentCallback(callback func(arg EnvironmentCallbackContext)) ResourceWithEnvironment
methodWithHttpsCertificateConfigurationbuilder
Adds a callback that allows configuring the resource to use a specific HTTPS/TLS certificate key pair for server authentication.
WithHttpsCertificateConfiguration(callback func(arg HttpsCertificateConfigurationCallbackAnnotationContext)) ResourceWithEnvironment
methodWithHttpsDeveloperCertificatebuilder
Indicates that a resource should use the developer certificate key pair for HTTPS endpoints at run time. Currently this indicates use of the ASP.NET Core developer certificate. The developer certificate will only be used when running in local development scenarios; in publish mode resources will use their default certificate configuration.
WithHttpsDeveloperCertificate(options ...*WithHttpsDeveloperCertificateOptions) ResourceWithEnvironment
methodWithOtlpExporterbuilder
Configures OTLP telemetry export
WithOtlpExporter(options ...*WithOtlpExporterOptions) ResourceWithEnvironment
methodWithoutHttpsCertificatebuilder
Disable HTTPS/TLS server certificate configuration for the resource. No HTTPS/TLS termination configuration will be applied.
WithoutHttpsCertificate() ResourceWithEnvironment
methodWithReferencebuilder
Adds a reference to another resource
WithReference(source any, options ...*WithReferenceOptions) ResourceWithEnvironment
methodWithReferenceEnvironmentbuilder
Configures how information is injected into environment variables when the resource references other resources.
WithReferenceEnvironment(options *ReferenceEnvironmentInjectionOptions) ResourceWithEnvironment

Exported values

WellKnownPipelineSteps.BeforeStartstring
= "before-start"
The step that runs before the application starts.
WellKnownPipelineSteps.Buildstring
= "build"
The well-known step for building resources.
WellKnownPipelineSteps.BuildPrereqstring
= "build-prereq"
The prerequisite step that runs before any build operations.
WellKnownPipelineSteps.CheckContainerRuntimestring
= "check-container-runtime"
The step that checks whether the container runtime (e.g., Docker or Podman) is running. Build steps that need a container runtime should depend on this step.
WellKnownPipelineSteps.Deploystring
= "deploy"
Aggregation step for all deploy operations. All deploy steps should be required by this step.
WellKnownPipelineSteps.DeployPrereqstring
= "deploy-prereq"
The prerequisite step that runs before any deploy operations.
WellKnownPipelineSteps.Destroystring
= "destroy"
Aggregation step for all destroy operations. All destroy steps should be required by this step.
WellKnownPipelineSteps.DestroyPrereqstring
= "destroy-prereq"
The prerequisite step that runs before any destroy operations.
WellKnownPipelineSteps.Diagnosticsstring
= "diagnostics"
The diagnostic step that dumps dependency graph information for troubleshooting.
WellKnownPipelineSteps.ProcessParametersstring
= "process-parameters"
The step that prompts for parameter values before build, publish, or deployment operations.
WellKnownPipelineSteps.Publishstring
= "publish"
Aggregation step for all publish operations. All publish steps should be required by this step.
WellKnownPipelineSteps.PublishPrereqstring
= "publish-prereq"
The prerequisite step that runs before any publish operations.
WellKnownPipelineSteps.Pushstring
= "push"
The meta-step that coordinates all push operations. All push steps should be required by this step.
WellKnownPipelineSteps.PushPrereqstring
= "push-prereq"
The prerequisite step that runs before any push operations.
WellKnownPipelineSteps.ValidateComputeEnvironmentsstring
= "validate-compute-environments"
The step that validates compute resources are assigned to unambiguous compute environments.
WellKnownPipelineTags.BuildComputestring
= "build-compute"
Tag for steps that build compute resources.
WellKnownPipelineTags.DeployComputestring
= "deploy-compute"
Tag for steps that deploy to compute infrastructure.
WellKnownPipelineTags.ProvisionInfrastructurestring
= "provision-infra"
Tag for steps that provision infrastructure resources.
WellKnownPipelineTags.PushContainerImagestring
= "push-container-image"
Tag for steps that push container images to a registry.