IResource

Interface

📦 Aspire.Hosting v13.6.0

interface IResource {
  createExecutionConfiguration(): IExecutionConfigurationBuilder;
  excludeFromManifest(): IResource;
  excludeFromMcp(): IResource;
  getResourceName(): string;
  onBeforeResourceStarted(callback: (arg: BeforeResourceStartedEvent) => Promise<void>): IResource;
  onInitializeResource(callback: (arg: InitializeResourceEvent) => Promise<void>): IResource;
  onResourceReady(callback: (arg: ResourceReadyEvent) => Promise<void>): IResource;
  onResourceStopped(callback: (arg: ResourceStoppedEvent) => Promise<void>): IResource;
  subscribeHttpsEndpointsUpdate(callback: (obj: HttpsEndpointUpdateCallbackContext) => Promise<void>): IResource;
  withChildRelationship(child: IResource): IResource;
  withCommand(name: string, displayName: string, executeCommand: (arg: ExecuteCommandContext) => Promise<ExecuteCommandResult>, commandOptions?: CommandOptions): IResource;
  withContainerBuildOptions(callback: (arg: ContainerBuildOptionsCallbackContext) => Promise<void>): IResource;
  withContainerRegistry(registry: IResource): IResource;
  withDockerfileBaseImage(
      buildImage?: string,
      runtimeImage?: string): IResource;
  withExplicitStart(): IResource;
  withHealthCheck(key: string): IResource;
  withHidden(): IResource;
  withHiddenOnCompletion(
      exitCode?: number,
      exitCodes?: number[]): IResource;
  withIconName(
      iconName: string,
      iconVariant?: IconVariant): IResource;
  withLifetimeOf(sourceBuilder: IResource): IResource;
  withParentProcessLifetime(parentProcessId: number): IResource;
  withParentRelationship(parent: IResource): IResource;
  withPersistentLifetime(): IResource;
  withPipelineConfiguration(callback: (obj: PipelineConfigurationContext) => Promise<void>): IResource;
  withPipelineStepFactory(stepName: string, callback: (arg: PipelineStepContext) => Promise<void>, dependsOn?: string[], requiredBy?: string[], tags?: string[], description?: string): IResource;
  withProcessCommand(
      commandName: string,
      displayName: string,
      options: ProcessCommandExportOptions): IResource;
  withProcessCommandFactory(commandName: string, displayName: string, createProcessSpec: (arg: ExecuteCommandContext) => Promise<ProcessCommandSpecExportData>, options?: ProcessCommandResultExportOptions): IResource;
  withRelationship(
      resourceBuilder: IResource,
      type: string): IResource;
  withRequiredCommand(
      command: string,
      helpLink?: string): IResource;
  withRequiredCommandValidation(command: string, validationCallback: (arg: RequiredCommandValidationContext) => Promise<RequiredCommandValidationResult>, helpLink?: string): IResource;
  withSessionLifetime(): IResource;
  withTerminal(): IResource;
  withUrl(
      url: string | ReferenceExpression,
      displayText?: string): IResource;
  withUrlForEndpoint(endpointName: string, callback: (obj: ResourceUrlAnnotation) => Promise<void>): IResource;
  withUrls(callback: (obj: ResourceUrlsCallbackContext) => Promise<void>): IResource;
}

35 members

Methods

methodcreateExecutionConfiguration

Creates an execution configuration builder for the specified resource.

createExecutionConfiguration(): IExecutionConfigurationBuilder

Returns

IExecutionConfigurationBuilder

methodexcludeFromManifestbuilder

Excludes a resource from being published to the manifest.

excludeFromManifest(): IResource

Returns

IResource

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(): IResource

Returns

IResource

methodgetResourceName

Gets the name of the resource from a builder.

getResourceName(): string

Returns

string

methodonBeforeResourceStartedbuilder

Subscribes to the BeforeResourceStarted event.

onBeforeResourceStarted(callback: (arg: BeforeResourceStartedEvent) => Promise<void>): IResource

Parameters

callback(arg: BeforeResourceStartedEvent) => Promise<void>

Returns

IResource

methodonInitializeResourcebuilder

Subscribes to the InitializeResource event.

onInitializeResource(callback: (arg: InitializeResourceEvent) => Promise<void>): IResource

Parameters

callback(arg: InitializeResourceEvent) => Promise<void>

Returns

IResource

methodonResourceReadybuilder

Subscribes to the ResourceReady event.

onResourceReady(callback: (arg: ResourceReadyEvent) => Promise<void>): IResource

Parameters

callback(arg: ResourceReadyEvent) => Promise<void>

Returns

IResource

methodonResourceStoppedbuilder

Subscribes to the ResourceStopped event.

onResourceStopped(callback: (arg: ResourceStoppedEvent) => Promise<void>): IResource

Parameters

callback(arg: ResourceStoppedEvent) => Promise<void>

Returns

IResource

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: (obj: HttpsEndpointUpdateCallbackContext) => Promise<void>): IResource

Parameters

callback(obj: HttpsEndpointUpdateCallbackContext) => Promise<void>

Returns

IResource

methodwithChildRelationshipbuilder

Sets a child relationship

withChildRelationship(child: IResource): IResource

Parameters

childIResource

Returns

IResource

methodwithCommandbuilder

Adds a resource command

withCommand(name: string, displayName: string, executeCommand: (arg: ExecuteCommandContext) => Promise<ExecuteCommandResult>, commandOptions?: CommandOptions): IResource

Parameters

namestring

displayNamestring

executeCommand(arg: ExecuteCommandContext) => Promise<ExecuteCommandResult>

commandOptionsCommandOptionsoptional

Returns

IResource

methodwithContainerBuildOptionsbuilder

Configures container build options for a compute resource using an async callback.

withContainerBuildOptions(callback: (arg: ContainerBuildOptionsCallbackContext) => Promise<void>): IResource

Parameters

callback(arg: ContainerBuildOptionsCallbackContext) => Promise<void>

Returns

IResource

methodwithContainerRegistrybuilder

Configures the resource to use the specified container registry for container image operations.

withContainerRegistry(registry: IResource): IResource

Parameters

registryIResource

Returns

IResource

methodwithDockerfileBaseImagebuilder

Configures custom base images for generated Dockerfiles.

withDockerfileBaseImage(
    buildImage?: string,
    runtimeImage?: string): IResource

Parameters

buildImagestringoptional

runtimeImagestringoptional

Returns

IResource

methodwithExplicitStartbuilder

Prevents resource from starting automatically

withExplicitStart(): IResource

Returns

IResource

methodwithHealthCheckbuilder

Adds a health check by key

withHealthCheck(key: string): IResource

Parameters

keystring

Returns

IResource

methodwithHiddenbuilder

Hides the resource from default resource lists

withHidden(): IResource

Returns

IResource

methodwithHiddenOnCompletionbuilder

Hides the resource from default resource lists after successful completion

withHiddenOnCompletion(
    exitCode?: number,
    exitCodes?: number[]): IResource

Parameters

exitCodenumberoptional

exitCodesnumber[]optional

Returns

IResource

methodwithIconNamebuilder

Specifies the icon to use when displaying the resource in the dashboard.

withIconName(
    iconName: string,
    iconVariant?: IconVariant): IResource

Parameters

iconNamestring

iconVariantIconVariantoptional= Filled

Returns

IResource

methodwithLifetimeOfbuilder

Configures a resource to match the lifetime of another resource.

withLifetimeOf(sourceBuilder: IResource): IResource

Parameters

sourceBuilderIResource

Returns

IResource

methodwithParentProcessLifetimebuilder

Configures a resource to use a persistent lifetime that ends when a parent process exits.

withParentProcessLifetime(parentProcessId: number): IResource

Parameters

parentProcessIdnumber

Returns

IResource

methodwithParentRelationshipbuilder

Sets the parent relationship

withParentRelationship(parent: IResource): IResource

Parameters

parentIResource

Returns

IResource

methodwithPersistentLifetimebuilder

Configures a resource to use a persistent lifetime.

withPersistentLifetime(): IResource

Returns

IResource

methodwithPipelineConfigurationbuilder

Registers a callback to be executed during the pipeline configuration phase, allowing modification of step dependencies and relationships.

withPipelineConfiguration(callback: (obj: PipelineConfigurationContext) => Promise<void>): IResource

Parameters

callback(obj: PipelineConfigurationContext) => Promise<void>

Returns

IResource

methodwithPipelineStepFactorybuilder

Adds a pipeline step to the resource that will be executed during deployment.

withPipelineStepFactory(stepName: string, callback: (arg: PipelineStepContext) => Promise<void>, dependsOn?: string[], requiredBy?: string[], tags?: string[], description?: string): IResource

Parameters

stepNamestring

callback(arg: PipelineStepContext) => Promise<void>

dependsOnstring[]optional

requiredBystring[]optional

tagsstring[]optional

descriptionstringoptional

Returns

IResource

methodwithProcessCommandbuilder

Adds a command to the resource that starts a local process when invoked.

withProcessCommand(
    commandName: string,
    displayName: string,
    options: ProcessCommandExportOptions): IResource

Parameters

commandNamestring

displayNamestring

optionsProcessCommandExportOptions

Returns

IResource

methodwithProcessCommandFactorybuilder

Adds a command to the resource that starts a local process created by a callback when invoked.

withProcessCommandFactory(commandName: string, displayName: string, createProcessSpec: (arg: ExecuteCommandContext) => Promise<ProcessCommandSpecExportData>, options?: ProcessCommandResultExportOptions): IResource

Parameters

commandNamestring

displayNamestring

createProcessSpec(arg: ExecuteCommandContext) => Promise<ProcessCommandSpecExportData>

optionsProcessCommandResultExportOptionsoptional

Returns

IResource

methodwithRelationshipbuilder

Adds a relationship to another resource using its builder.

withRelationship(
    resourceBuilder: IResource,
    type: string): IResource

Parameters

resourceBuilderIResource

typestring

Returns

IResource

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,
    helpLink?: string): IResource

Parameters

commandstring

helpLinkstringoptional

Returns

IResource

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: (arg: RequiredCommandValidationContext) => Promise<RequiredCommandValidationResult>, helpLink?: string): IResource

Parameters

commandstring

validationCallback(arg: RequiredCommandValidationContext) => Promise<RequiredCommandValidationResult>

helpLinkstringoptional

Returns

IResource

methodwithSessionLifetimebuilder

Configures a resource to use a session lifetime.

withSessionLifetime(): IResource

Returns

IResource

methodwithTerminalbuilder

Adds an interactive terminal session to a resource using the default terminal options.

withTerminal(): IResource

Returns

IResource

methodwithUrlbuilder

Adds or modifies displayed URLs

withUrl(
    url: string | ReferenceExpression,
    displayText?: string): IResource

Parameters

urlstring | ReferenceExpression

displayTextstringoptional

Returns

IResource

methodwithUrlForEndpointbuilder

Registers a callback to update the URL displayed for the endpoint with the specified name.

withUrlForEndpoint(endpointName: string, callback: (obj: ResourceUrlAnnotation) => Promise<void>): IResource

Parameters

endpointNamestring

callback(obj: ResourceUrlAnnotation) => Promise<void>

Returns

IResource

methodwithUrlsbuilder

Registers a callback to customize the URLs displayed for the resource.

withUrls(callback: (obj: ResourceUrlsCallbackContext) => Promise<void>): IResource

Parameters

callback(obj: ResourceUrlsCallbackContext) => Promise<void>

Returns

IResource