IResource

Interface

📦 Aspire.Hosting v13.3.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;
  withChildRelationship(child: IResource): IResource;
  withCommand(name: string, displayName: string, executeCommand: (arg: ExecuteCommandContext) => Promise<ExecuteCommandResult>, commandOptions?: CommandOptions): IResource;
  withContainerRegistry(registry: IResource): IResource;
  withDockerfileBaseImage(
      buildImage?: string,
      runtimeImage?: string): IResource;
  withExplicitStart(): IResource;
  withHealthCheck(key: string): IResource;
  withIconName(
      iconName: string,
      iconVariant?: IconVariant): IResource;
  withParentRelationship(parent: IResource): 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;
  withRelationship(
      resourceBuilder: IResource,
      type: string): IResource;
  withRequiredCommand(
      command: string,
      helpLink?: string): IResource;
  withUrl(
      url: ReferenceExpression,
      displayText?: string): IResource;
  withUrlForEndpoint(endpointName: string, callback: (obj: ResourceUrlAnnotation) => Promise<void>): IResource;
  withUrls(callback: (obj: ResourceUrlsCallbackContext) => Promise<void>): IResource;
}

23 members

Methods

method createExecutionConfiguration

Creates an execution configuration builder

createExecutionConfiguration(): IExecutionConfigurationBuilder

Returns

IExecutionConfigurationBuilder

method excludeFromManifest builder

Excludes the resource from the deployment manifest

excludeFromManifest(): IResource

Returns

IResource

method excludeFromMcp builder

Excludes the resource from MCP server exposure

excludeFromMcp(): IResource

Returns

IResource

method getResourceName

Gets the resource name

getResourceName(): string

Returns

string

method onBeforeResourceStarted builder

Subscribes to the BeforeResourceStarted event

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

Parameters

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

Returns

IResource

method onInitializeResource builder

Subscribes to the InitializeResource event

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

Parameters

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

Returns

IResource

method onResourceReady builder

Subscribes to the ResourceReady event

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

Parameters

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

Returns

IResource

method onResourceStopped builder

Subscribes to the ResourceStopped event

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

Parameters

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

Returns

IResource

method withChildRelationship builder

Sets a child relationship

withChildRelationship(child: IResource): IResource

Parameters

child IResource

Returns

IResource

method withCommand builder

Adds a resource command

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

Parameters

name string

displayName string

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

commandOptions CommandOptions optional

Returns

IResource

method withContainerRegistry builder

Configures a resource to use a container registry

withContainerRegistry(registry: IResource): IResource

Parameters

registry IResource

Returns

IResource

method withDockerfileBaseImage builder

Sets the base image for a Dockerfile build

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

Parameters

buildImage string optional

runtimeImage string optional

Returns

IResource

method withExplicitStart builder

Prevents resource from starting automatically

withExplicitStart(): IResource

Returns

IResource

method withHealthCheck builder

Adds a health check by key

withHealthCheck(key: string): IResource

Parameters

key string

Returns

IResource

method withIconName builder

Sets the icon for the resource

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

Parameters

iconName string

iconVariant IconVariant optional = Filled

Returns

IResource

method withParentRelationship builder

Sets the parent relationship

withParentRelationship(parent: IResource): IResource

Parameters

parent IResource

Returns

IResource

method withPipelineConfiguration builder

Configures pipeline step dependencies via a callback

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

Parameters

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

Returns

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

Parameters

stepName string

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

dependsOn string[] optional

requiredBy string[] optional

tags string[] optional

description string optional

Returns

IResource

method withRelationship builder

Adds a relationship to another resource

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

Parameters

resourceBuilder IResource

type string

Returns

IResource

method withRequiredCommand builder

Adds a required command dependency

withRequiredCommand(
    command: string,
    helpLink?: string): IResource

Parameters

command string

helpLink string optional

Returns

IResource

method withUrl builder

Adds or modifies displayed URLs

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

Parameters

url ReferenceExpression

displayText string optional

Returns

IResource

method withUrlForEndpoint builder

Customizes the URL for a specific endpoint via callback

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

Parameters

endpointName string

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

Returns

IResource

method withUrls builder

Customizes displayed URLs via callback

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

Parameters

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

Returns

IResource