Aspire.Hosting
Official
📦 Aspire.Hosting v13.3.0 188 Functions
102 Types
102 types and 173 members
Types
type
AddContainerOptions 2 fields handle
AfterResourcesCreatedEvent 2 members handle
BeforeResourceStartedEvent 2 members handle
BeforeStartEvent 2 members type
CertificateTrustExecutionConfigurationContext 4 fields type
CertificateTrustExecutionConfigurationExportData 3 fields handle
CommandLineArgsCallbackContext 4 members handle
CommandLineArgsEditor 1 members type
CommandOptions 7 fields type
CommandResultData 3 fields handle
ConnectionStringAvailableEvent 2 members handle
ContainerImagePushOptions 4 members handle
ContainerImagePushOptionsCallbackContext 6 members handle
ContainerImageReference handle
ContainerMountAnnotation handle
ContainerPortReference handle
ContainerRegistryResource handle
ContainerResource 20 members type
CreateBuilderOptions 8 fields handle
CSharpAppResource handle
DistributedApplication 1 members handle
DistributedApplicationEventSubscription handle
DistributedApplicationExecutionContext 6 members handle
DistributedApplicationExecutionContextOptions handle
DistributedApplicationModel 2 members handle
DistributedApplicationResourceEventSubscription handle
DockerfileBuilder 3 members handle
DockerfileBuilderCallbackContext 4 members handle
DockerfileStage 14 members handle
DotnetToolResource 6 members handle
EndpointReference 19 members handle
EndpointReferenceExpression 3 members handle
EndpointUpdateContext 21 members handle
EnvironmentCallbackContext 4 members handle
EnvironmentEditor 1 members handle
EventingSubscriberRegistrationContext 4 members handle
ExecutableResource 3 members handle
ExecuteCommandContext 8 members type
ExecuteCommandResult 5 fields handle
ExternalServiceResource 1 members type
GenerateParameterDefault 9 fields type
HttpCommandExportOptions 9 fields type
HttpsCertificateExecutionConfigurationContext 3 fields type
HttpsCertificateExecutionConfigurationExportData 7 fields type
HttpsCertificateInfo 3 fields interface
IAspireStore 1 members interface
IDistributedApplicationBuilder 25 members interface
IDistributedApplicationEvent interface
IDistributedApplicationEventing 1 members interface
IDistributedApplicationPipeline 3 members interface
IDistributedApplicationResourceEvent interface
IExecutionConfigurationBuilder 5 members interface
IExecutionConfigurationResult 2 members interface
IExpressionValue handle
InitializeResourceEvent 5 members interface
IReportingStep 6 members interface
IReportingTask 4 members interface
IResource 23 members interface
IResourceWithArgs 2 members interface
IResourceWithConnectionString 3 members interface
IResourceWithContainerFiles 2 members interface
IResourceWithEndpoints 14 members interface
IResourceWithEnvironment 9 members interface
IResourceWithParent interface
IResourceWithWaitSupport 3 members interface
IUserSecretsManager 6 members handle
LogFacade 4 members handle
ParameterResource 1 members handle
PipelineConfigurationContext 3 members handle
PipelineContext 7 members handle
PipelineEditor 2 members handle
PipelineStep 5 members handle
PipelineStepContext 10 members handle
PipelineStepFactoryContext 4 members handle
PipelineSummary 2 members handle
ProjectResource 3 members handle
ProjectResourceOptions 6 members type
ReferenceEnvironmentInjectionOptions 4 fields handle
ReferenceExpression 1 members handle
ReferenceExpressionBuilder 5 members handle
ResourceEndpointsAllocatedEvent 2 members type
ResourceEventDto 6 fields handle
ResourceLoggerService 2 members handle
ResourceNotificationService 6 members handle
ResourceReadyEvent 2 members handle
ResourceStoppedEvent 2 members type
ResourceUrlAnnotation 4 fields handle
ResourceUrlsCallbackContext 5 members handle
ResourceUrlsEditor 3 members handle
UpdateCommandStateContext 2 members Functions
method
addConnectionString builder Adds a connection string resource
addConnectionString(name: string, environmentVariableNameOrExpression?: ReferenceExpression): IResourceWithConnectionString method
addContainer builder Adds a container resource
addContainer(name: string, image: AddContainerOptions): ContainerResource method
addContainerFiles Adds COPY --from statements for published container files
addContainerFiles(resource: IResource, rootDestinationPath: string, logger?: ILogger): DockerfileStage method
addContainerFilesStages Adds Dockerfile stages for published container files
addContainerFilesStages(resource: IResource, logger?: ILogger): DockerfileBuilder method
addContainerRegistry builder Adds a container registry resource
addContainerRegistry(name: string, endpoint: ParameterResource, repository?: ParameterResource): ContainerRegistryResource method
addCSharpApp builder Adds a C# application resource
addCSharpApp(name: string, path: string, options?: ProjectResourceOptions): CSharpAppResource method
addDockerfile builder Adds a container resource built from a Dockerfile
addDockerfile(name: string, contextPath: string, dockerfilePath?: string, stage?: string): ContainerResource method
addDockerfileBuilder builder Adds a container resource built from a programmatically generated Dockerfile
addDockerfileBuilder(name: string, contextPath: string, callback: (arg: DockerfileBuilderCallbackContext) => Promise<void>, stage?: string): ContainerResource method
addDotnetTool builder Adds a .NET tool resource
addDotnetTool(name: string, packageId: string): DotnetToolResource method
addEventingSubscriber Adds an eventing subscriber
addEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise<void>): void method
addExecutable builder Adds an executable resource
addExecutable(name: string, command: string, workingDirectory: string, args: string[]): ExecutableResource method
addExternalService builder Adds an external service resource
addExternalService(name: string, url: ParameterResource): ExternalServiceResource method
addMarkdown Adds a Markdown-formatted value to the pipeline summary
addMarkdown(key: string, markdownString: string): void method
addParameter builder Adds a parameter resource
addParameter(name: string, value?: string, publishValueAsDefault?: boolean, secret?: boolean): ParameterResource method
addParameterFromConfiguration builder Adds a parameter sourced from configuration
addParameterFromConfiguration(name: string, configurationKey: string, secret?: boolean): ParameterResource method
addParameterWithGeneratedValue builder Adds a parameter with a generated default value
addParameterWithGeneratedValue(name: string, value: GenerateParameterDefault, secret?: boolean, persist?: boolean): ParameterResource method
addProject builder Adds a .NET project resource
addProject(name: string, projectPath: string, launchProfileOrOptions?: ProjectResourceOptions): ProjectResource method
addStep Adds a pipeline step to the application
addStep(stepName: string, callback: (arg: PipelineStepContext) => Promise<void>, dependsOn?: string[], requiredBy?: string[]): void method
arg Adds a global ARG statement to the Dockerfile
arg(name: string, defaultValue?: string): DockerfileBuilder method
arg Adds an ARG statement to a Dockerfile stage
arg(name: string, defaultValue?: string): DockerfileStage method
asHttp2Service builder Configures resource for HTTP/2
asHttp2Service(): IResourceWithEndpoints method
build Builds the execution configuration
build(executionContext: DistributedApplicationExecutionContext, resourceLogger?: ILogger, cancellationToken?: cancellationToken): IExecutionConfigurationResult method
clearContainerFilesSources builder Clears all container file sources
clearContainerFilesSources(): IResourceWithContainerFiles method
cmd Adds a CMD statement to a Dockerfile stage
cmd(command: string[]): DockerfileStage method
comment Adds a comment to a Dockerfile stage
comment(comment: string): DockerfileStage method
completeLog Completes the log stream for a resource
completeLog(resource: IResource): void method
completeLogByName Completes the log stream by resource name
completeLogByName(resourceName: string): void method
completeStep Completes the reporting step with plain-text completion text
completeStep(completionText: string, completionState?: string, cancellationToken?: cancellationToken): void method
completeStepMarkdown Completes the reporting step with Markdown-formatted completion text
completeStepMarkdown(markdownString: string, completionState?: string, cancellationToken?: cancellationToken): void method
completeTask Completes the reporting task with plain-text completion text
completeTask(completionMessage?: string, completionState?: string, cancellationToken?: cancellationToken): void method
completeTaskMarkdown Completes the reporting task with Markdown-formatted completion text
completeTaskMarkdown(markdownString: string, completionState?: string, cancellationToken?: cancellationToken): void method
configure Configures the application pipeline via a callback
configure(callback: (arg: PipelineConfigurationContext) => Promise<void>): void method
copy Adds a COPY statement to a Dockerfile stage
copy(source: string, destination: string, chown?: string): DockerfileStage method
copyFrom Adds a COPY --from statement to a Dockerfile stage
copyFrom(from: string, source: string, destination: string, chown?: string): DockerfileStage method
createBuilder Creates a new distributed application builder
createBuilder(): IDistributedApplicationBuilder method
createExecutionConfiguration Creates an execution configuration builder
createExecutionConfiguration(): IExecutionConfigurationBuilder method
createLogger Creates a logger for a category
createLogger(categoryName: string): ILogger method
createMarkdownTask Creates a reporting task with Markdown-formatted status text
createMarkdownTask(markdownString: string, cancellationToken?: cancellationToken): IReportingTask method
createTask Creates a reporting task with plain-text status text
createTask(statusText: string, cancellationToken?: cancellationToken): IReportingTask method
disableBuildOnlyContainerValidation Disables publish and deploy validation for unconsumed build-only containers.
disableBuildOnlyContainerValidation(): IDistributedApplicationPipeline method
disableForwardedHeaders builder Disables forwarded headers for the project
disableForwardedHeaders(): ProjectResource method
emptyLine Adds an empty line to a Dockerfile stage
emptyLine(): DockerfileStage method
entrypoint Adds an ENTRYPOINT statement to a Dockerfile stage
entrypoint(command: string[]): DockerfileStage method
env Adds an ENV statement to a Dockerfile stage
env(name: string, value: string): DockerfileStage method
excludeFromManifest builder Excludes the resource from the deployment manifest
excludeFromManifest(): IResource method
excludeFromMcp builder Excludes the resource from MCP server exposure
excludeFromMcp(): IResource method
exists Checks whether a configuration section exists
exists(key: string): boolean method
expose Adds an EXPOSE statement to a Dockerfile stage
expose(port: number): DockerfileStage method
findResourceByName Finds a resource by name
findResourceByName(name: string): IResource method
from Adds a FROM statement to start a Dockerfile stage
from(image: string, stageName?: string): DockerfileStage method
getAspireStore Gets the Aspire store from the service provider
getAspireStore(): IAspireStore method
getCertificateTrustData Gets certificate trust execution-configuration data
getCertificateTrustData(): CertificateTrustExecutionConfigurationExportData method
getChildren Gets child configuration sections
getChildren(): IConfigurationSection[] method
getConfiguration Gets the application configuration
getConfiguration(): IConfiguration method
getConfigValue Gets a configuration value by key
getConfigValue(key: string): string method
getConnectionProperty Gets a connection property by key
getConnectionProperty(key: string): ReferenceExpression method
getConnectionString Gets a connection string by name
getConnectionString(name: string): string method
getDistributedApplicationModel Gets the distributed application model from the service provider
getDistributedApplicationModel(): DistributedApplicationModel method
getEndpoint Gets an endpoint reference
getEndpoint(name: string): EndpointReference method
getEventing Gets the distributed application eventing service from the service provider
getEventing(): IDistributedApplicationEventing method
getFileNameWithContent Gets a deterministic file path for the specified file contents
getFileNameWithContent(filenameTemplate: string, sourceFilename: string): string method
getHttpsCertificateData Gets HTTPS certificate execution-configuration data
getHttpsCertificateData(): HttpsCertificateExecutionConfigurationExportData method
getLoggerFactory Gets the logger factory from the service provider
getLoggerFactory(): ILoggerFactory method
getOrSetSecret Gets a secret value if it exists, or sets it to the provided value if it does not
getOrSetSecret(resourceBuilder: IResource, name: string, value: string): void method
getResourceLoggerService Gets the resource logger service from the service provider
getResourceLoggerService(): ResourceLoggerService method
getResourceName Gets the resource name
getResourceName(): string method
getResourceNotificationService Gets the resource notification service from the service provider
getResourceNotificationService(): ResourceNotificationService method
getResources Gets resources from the distributed application model
getResources(): IResource[] method
getSection Gets a configuration section by key
getSection(key: string): IConfigurationSection method
getUserSecretsManager Gets the user secrets manager from the service provider
getUserSecretsManager(): IUserSecretsManager method
isDevelopment Checks if running in Development environment
isDevelopment(): boolean method
isEnvironment Checks if the environment matches the specified name
isEnvironment(environmentName: string): boolean method
isProduction Checks if running in Production environment
isProduction(): boolean method
isStaging Checks if running in Staging environment
isStaging(): boolean method
log Logs a message with specified level
log(level: string, message: string): void method
logDebug Logs a debug message
logDebug(message: string): void method
logError Logs an error message
logError(message: string): void method
logInformation Logs an information message
logInformation(message: string): void method
logStep Logs a plain-text message for the reporting step
logStep(level: string, message: string): void method
logStepMarkdown Logs a Markdown-formatted message for the reporting step
logStepMarkdown(level: string, markdownString: string): void method
logWarning Logs a warning message
logWarning(message: string): void method
onAfterResourcesCreated Subscribes an eventing subscriber to the AfterResourcesCreated event
onAfterResourcesCreated(callback: (arg: AfterResourcesCreatedEvent) => Promise<void>): DistributedApplicationEventSubscription method
onBeforeResourceStarted builder Subscribes to the BeforeResourceStarted event
onBeforeResourceStarted(callback: (arg: BeforeResourceStartedEvent) => Promise<void>): IResource method
onBeforeStart Subscribes an eventing subscriber to the BeforeStart event
onBeforeStart(callback: (arg: BeforeStartEvent) => Promise<void>): DistributedApplicationEventSubscription method
onConnectionStringAvailable builder Subscribes to the ConnectionStringAvailable event
onConnectionStringAvailable(callback: (arg: ConnectionStringAvailableEvent) => Promise<void>): IResourceWithConnectionString method
onInitializeResource builder Subscribes to the InitializeResource event
onInitializeResource(callback: (arg: InitializeResourceEvent) => Promise<void>): IResource method
onResourceEndpointsAllocated builder Subscribes to the ResourceEndpointsAllocated event
onResourceEndpointsAllocated(callback: (arg: ResourceEndpointsAllocatedEvent) => Promise<void>): IResourceWithEndpoints method
onResourceReady builder Subscribes to the ResourceReady event
onResourceReady(callback: (arg: ResourceReadyEvent) => Promise<void>): IResource method
onResourceStopped builder Subscribes to the ResourceStopped event
onResourceStopped(callback: (arg: ResourceStoppedEvent) => Promise<void>): IResource method
publishAsConnectionString builder Publishes the resource as a connection string
publishAsConnectionString(): ContainerResource method
publishAsContainer builder Configures the resource to be published as a container
publishAsContainer(): ContainerResource method
publishAsDockerFile builder Publishes an executable as a Docker file
publishAsDockerFile(configure: (obj: ContainerResource) => Promise<void>): ExecutableResource method
publishAsDockerFile builder Publishes a project as a Docker file with optional container configuration
publishAsDockerFile(configure?: (obj: ContainerResource) => Promise<void>): ProjectResource method
publishResourceUpdate Publishes an update for a resource's state
publishResourceUpdate(resource: IResource, state?: string, stateStyle?: string): void method
publishWithContainerFiles builder Configures the resource to copy container files from the specified source during publishing
publishWithContainerFiles(source: IResourceWithContainerFiles, destinationPath: string): IContainerFilesDestinationResource method
run Adds a RUN statement to a Dockerfile stage
run(command: string): DockerfileStage method
runWithMounts Adds a RUN statement with mounts to a Dockerfile stage
runWithMounts(command: string, mounts: string[]): DockerfileStage method
saveStateJson Saves state to user secrets from a JSON string
saveStateJson(json: string, cancellationToken?: cancellationToken): void method
subscribeAfterResourcesCreated Subscribes to the AfterResourcesCreated event
subscribeAfterResourcesCreated(callback: (arg: AfterResourcesCreatedEvent) => Promise<void>): DistributedApplicationEventSubscription method
subscribeBeforeStart Subscribes to the BeforeStart event
subscribeBeforeStart(callback: (arg: BeforeStartEvent) => Promise<void>): DistributedApplicationEventSubscription method
tryAddEventingSubscriber Attempts to add an eventing subscriber
tryAddEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise<void>): void method
tryGetResourceState Tries to get the current state of a resource
tryGetResourceState(resourceName: string): ResourceEventDto method
updateTask Updates the reporting task with plain-text status text
updateTask(statusText: string, cancellationToken?: cancellationToken): void method
updateTaskMarkdown Updates the reporting task with Markdown-formatted status text
updateTaskMarkdown(markdownString: string, cancellationToken?: cancellationToken): void method
user Adds a USER statement to a Dockerfile stage
user(user: string): DockerfileStage method
waitFor builder Waits for another resource to be ready
waitFor(dependency: IResource, waitBehavior?: WaitBehavior): IResourceWithWaitSupport method
waitForCompletion builder Waits for resource completion
waitForCompletion(dependency: IResource, exitCode?: number): IResourceWithWaitSupport method
waitForDependencies Waits for all dependencies of a resource to be ready
waitForDependencies(resource: IResource): void method
waitForResourceHealthy Waits for a resource to become healthy
waitForResourceHealthy(resourceName: string): ResourceEventDto method
waitForResourceState Waits for a resource to reach a specified state
waitForResourceState(resourceName: string, targetState?: string): void method
waitForResourceStates Waits for a resource to reach one of the specified states
waitForResourceStates(resourceName: string, targetStates: string[]): string method
waitForStart builder Waits for another resource to start
waitForStart(dependency: IResource, waitBehavior?: WaitBehavior): IResourceWithWaitSupport method
withArgs builder Adds arguments
withArgs(args: string[]): IResourceWithArgs method
withArgsCallback builder Sets command-line arguments via callback
withArgsCallback(callback: (obj: CommandLineArgsCallbackContext) => Promise<void>): IResourceWithArgs method
withArgumentsConfig Adds an arguments configuration gatherer
withArgumentsConfig(): IExecutionConfigurationBuilder method
withBindMount builder Adds a bind mount
withBindMount(source: string, target: string, isReadOnly?: boolean): ContainerResource method
withBuildArg builder Adds a build argument from a string value or parameter resource
withBuildArg(name: string, value: ParameterResource): ContainerResource method
withBuildSecret builder Adds a build secret from a parameter resource
withBuildSecret(name: string, value: ParameterResource): ContainerResource method
withCertificateTrustConfig Adds a certificate trust configuration gatherer
withCertificateTrustConfig(configContextFactory: (arg: CertificateTrustScope) => Promise<CertificateTrustExecutionConfigurationContext>): IExecutionConfigurationBuilder method
withCertificateTrustScope builder Sets the certificate trust scope
withCertificateTrustScope(scope: CertificateTrustScope): IResourceWithEnvironment method
withChildRelationship builder Sets a child relationship
withChildRelationship(child: IResource): IResource method
withCommand builder Adds a resource command
withCommand(name: string, displayName: string, executeCommand: (arg: ExecuteCommandContext) => Promise<ExecuteCommandResult>, commandOptions?: CommandOptions): IResource method
withConnectionProperty builder Adds a connection property with a string or reference expression value
withConnectionProperty(name: string, value: ReferenceExpression): IResourceWithConnectionString method
withContainerCertificatePaths builder Overrides container certificate bundle and directory paths used for trust configuration
withContainerCertificatePaths(customCertificatesDestination?: string, defaultCertificateBundlePaths?: string[], defaultCertificateDirectoryPaths?: string[]): ContainerResource method
withContainerFilesSource builder Sets the source directory for container files
withContainerFilesSource(sourcePath: string): IResourceWithContainerFiles method
withContainerName builder Sets the container name
withContainerName(name: string): ContainerResource method
withContainerNetworkAlias builder Adds a network alias for the container
withContainerNetworkAlias(alias: string): ContainerResource method
withContainerRegistry builder Configures a resource to use a container registry
withContainerRegistry(registry: IResource): IResource method
withContainerRuntimeArgs builder Adds runtime arguments for the container
withContainerRuntimeArgs(args: string[]): ContainerResource method
withDescription builder Sets a parameter description
withDescription(description: string, enableMarkdown?: boolean): ParameterResource method
withDeveloperCertificateTrust builder Configures developer certificate trust
withDeveloperCertificateTrust(trust: boolean): IResourceWithEnvironment method
withDockerfile builder Configures the resource to use a Dockerfile
withDockerfile(contextPath: string, dockerfilePath?: string, stage?: string): ContainerResource method
withDockerfileBaseImage builder Sets the base image for a Dockerfile build
withDockerfileBaseImage(buildImage?: string, runtimeImage?: string): IResource method
withDockerfileBuilder builder Configures the resource to use a programmatically generated Dockerfile
withDockerfileBuilder(contextPath: string, callback: (arg: DockerfileBuilderCallbackContext) => Promise<void>, stage?: string): ContainerResource method
withEndpoint builder Adds a network endpoint
withEndpoint(port?: number, targetPort?: number, scheme?: string, name?: string, env?: string, isProxied?: boolean, isExternal?: boolean, protocol?: ProtocolType): IResourceWithEndpoints method
withEndpointCallback builder Updates a named endpoint via callback
withEndpointCallback(endpointName: string, callback: (obj: EndpointUpdateContext) => Promise<void>, createIfNotExists?: boolean): IResourceWithEndpoints method
withEndpointProxySupport builder Configures endpoint proxy support
withEndpointProxySupport(proxyEnabled: boolean): ContainerResource method
withEntrypoint builder Sets the container entrypoint
withEntrypoint(entrypoint: string): ContainerResource method
withEnvironment builder Sets an environment variable
withEnvironment(name: string, value: IExpressionValue): IResourceWithEnvironment method
withEnvironmentCallback builder Sets environment variables via callback
withEnvironmentCallback(callback: (arg: EnvironmentCallbackContext) => Promise<void>): IResourceWithEnvironment method
withEnvironmentVariablesConfig Adds an environment variables configuration gatherer
withEnvironmentVariablesConfig(): IExecutionConfigurationBuilder method
withExecutableCommand builder Sets the executable command
withExecutableCommand(command: string): ExecutableResource method
withExplicitStart builder Prevents resource from starting automatically
withExplicitStart(): IResource method
withExternalHttpEndpoints builder Makes HTTP endpoints externally accessible
withExternalHttpEndpoints(): IResourceWithEndpoints method
withHealthCheck builder Adds a health check by key
withHealthCheck(key: string): IResource method
withHttpCommand builder Adds an HTTP resource command
withHttpCommand(path: string, displayName: string, options?: HttpCommandExportOptions): IResourceWithEndpoints method
withHttpEndpoint builder Adds an HTTP endpoint
withHttpEndpoint(port?: number, targetPort?: number, name?: string, env?: string, isProxied?: boolean): IResourceWithEndpoints method
withHttpEndpointCallback builder Updates an HTTP endpoint via callback
withHttpEndpointCallback(callback: (obj: EndpointUpdateContext) => Promise<void>, name?: string, createIfNotExists?: boolean): IResourceWithEndpoints method
withHttpHealthCheck builder Adds an HTTP health check to the external service
withHttpHealthCheck(path?: string, statusCode?: number, endpointName?: string): ExternalServiceResource method
withHttpHealthCheck builder Adds an HTTP health check
withHttpHealthCheck(path?: string, statusCode?: number, endpointName?: string): IResourceWithEndpoints method
withHttpProbe builder Adds an HTTP health probe to the resource
withHttpProbe(probeType: ProbeType, path?: string, initialDelaySeconds?: number, periodSeconds?: number, timeoutSeconds?: number, failureThreshold?: number, successThreshold?: number, endpointName?: string): IResourceWithEndpoints method
withHttpsCertificateConfig Adds an HTTPS certificate configuration gatherer
withHttpsCertificateConfig(configContextFactory: (arg: HttpsCertificateInfo) => Promise<HttpsCertificateExecutionConfigurationContext>): IExecutionConfigurationBuilder method
withHttpsDeveloperCertificate builder Configures HTTPS with a developer certificate
withHttpsDeveloperCertificate(password?: ParameterResource): IResourceWithEnvironment method
withHttpsEndpoint builder Adds an HTTPS endpoint
withHttpsEndpoint(port?: number, targetPort?: number, name?: string, env?: string, isProxied?: boolean): IResourceWithEndpoints method
withHttpsEndpointCallback builder Updates an HTTPS endpoint via callback
withHttpsEndpointCallback(callback: (obj: EndpointUpdateContext) => Promise<void>, name?: string, createIfNotExists?: boolean): IResourceWithEndpoints method
withIconName builder Sets the icon for the resource
withIconName(iconName: string, iconVariant?: IconVariant): IResource method
withImage builder Sets the container image
withImage(image: string, tag?: string): ContainerResource method
withImagePullPolicy builder Sets the container image pull policy
withImagePullPolicy(pullPolicy: ImagePullPolicy): ContainerResource method
withImagePushOptions builder Sets image push options via callback
withImagePushOptions(callback: (arg: ContainerImagePushOptionsCallbackContext) => Promise<void>): IComputeResource method
withImageRegistry builder Sets the container image registry
withImageRegistry(registry: string): ContainerResource method
withImageSHA256 builder Sets the image SHA256 digest
withImageSHA256(sha256: string): ContainerResource method
withImageTag builder Sets the container image tag
withImageTag(tag: string): ContainerResource method
withLifetime builder Sets the lifetime behavior of the container resource
withLifetime(lifetime: ContainerLifetime): ContainerResource method
withMcpServer builder Configures an MCP server endpoint on the resource
withMcpServer(path?: string, endpointName?: string): IResourceWithEndpoints method
withOtlpExporter builder Configures OTLP telemetry export
withOtlpExporter(protocol?: OtlpProtocol): IResourceWithEnvironment method
withoutHttpsCertificate builder Removes HTTPS certificate configuration
withoutHttpsCertificate(): IResourceWithEnvironment method
withParentRelationship builder Sets the parent relationship
withParentRelationship(parent: IResource): IResource method
withPipelineConfiguration builder Configures pipeline step dependencies via a callback
withPipelineConfiguration(callback: (obj: PipelineConfigurationContext) => Promise<void>): IResource method
withPipelineStepFactory builder Adds a pipeline step to the resource
withPipelineStepFactory(stepName: string, callback: (arg: PipelineStepContext) => Promise<void>, dependsOn?: string[], requiredBy?: string[], tags?: string[], description?: string): IResource method
withReference builder Adds a reference to another resource
withReference(source: EndpointReference|string|uri, connectionName?: string, optional?: boolean, name?: string): IResourceWithEnvironment method
withReferenceEnvironment builder Configures which reference values are injected into environment variables
withReferenceEnvironment(options: ReferenceEnvironmentInjectionOptions): IResourceWithEnvironment method
withRelationship builder Adds a relationship to another resource
withRelationship(resourceBuilder: IResource, type: string): IResource method
withRemoteImageName builder Sets the remote image name for publishing
withRemoteImageName(remoteImageName: string): IComputeResource method
withRemoteImageTag builder Sets the remote image tag for publishing
withRemoteImageTag(remoteImageTag: string): IComputeResource method
withReplicas builder Sets the number of replicas
withReplicas(replicas: number): ProjectResource method
withRequiredCommand builder Adds a required command dependency
withRequiredCommand(command: string, helpLink?: string): IResource method
withToolIgnoreExistingFeeds builder Ignores existing NuGet feeds
withToolIgnoreExistingFeeds(): DotnetToolResource method
withToolIgnoreFailedSources builder Ignores failed NuGet sources
withToolIgnoreFailedSources(): DotnetToolResource method
withToolPackage builder Sets the tool package ID
withToolPackage(packageId: string): DotnetToolResource method
withToolPrerelease builder Allows prerelease tool versions
withToolPrerelease(): DotnetToolResource method
withToolSource builder Adds a NuGet source for the tool
withToolSource(source: string): DotnetToolResource method
withToolVersion builder Sets the tool version
withToolVersion(version: string): DotnetToolResource method
withUrl builder Adds or modifies displayed URLs
withUrl(url: ReferenceExpression, displayText?: string): IResource method
withUrlForEndpoint builder Customizes the URL for a specific endpoint via callback
withUrlForEndpoint(endpointName: string, callback: (obj: ResourceUrlAnnotation) => Promise<void>): IResource method
withUrls builder Customizes displayed URLs via callback
withUrls(callback: (obj: ResourceUrlsCallbackContext) => Promise<void>): IResource method
withVolume builder Adds a volume
withVolume(target: string, name?: string, isReadOnly?: boolean): ContainerResource method
withWorkingDirectory builder Sets the executable working directory
withWorkingDirectory(workingDirectory: string): ExecutableResource method
workDir Adds a WORKDIR statement to a Dockerfile stage
workDir(path: string): DockerfileStage Enums
enum
CertificateTrustScope 4 values enum
CommandResultFormat 3 values enum
ContainerLifetime 2 values enum
DistributedApplicationOperation 2 values enum
EndpointProperty 8 values enum
HttpCommandResultMode 4 values enum
IconVariant 2 values enum
ImagePullPolicy 4 values enum
OtlpProtocol 3 values enum
ProbeType 3 values enum
UrlDisplayLocation 2 values enum
WaitBehavior 2 values