IResourceWithEndpoints

Interface

📦 Aspire.Hosting v13.4.0

interface IResourceWithEndpoints {
  asHttp2Service(): IResourceWithEndpoints;
  getEndpoint(name: string): EndpointReference;
  onResourceEndpointsAllocated(callback: (arg: ResourceEndpointsAllocatedEvent) => Promise<void>): IResourceWithEndpoints;
  withEndpoint(
      port?: number,
      targetPort?: number,
      scheme?: string,
      name?: string,
      env?: string,
      isProxied?: boolean,
      isExternal?: boolean,
      protocol?: ProtocolType): IResourceWithEndpoints;
  withEndpointCallback(endpointName: string, callback: (obj: EndpointUpdateContext) => Promise<void>, createIfNotExists?: boolean): IResourceWithEndpoints;
  withEndpointProxySupport(proxyEnabled: boolean): IResourceWithEndpoints;
  withExternalHttpEndpoints(): IResourceWithEndpoints;
  withHttpCommand(
      path: string,
      displayName: string,
      options?: HttpCommandExportOptions): IResourceWithEndpoints;
  withHttpEndpoint(
      port?: number,
      targetPort?: number,
      name?: string,
      env?: string,
      isProxied?: boolean): IResourceWithEndpoints;
  withHttpEndpointCallback(callback: (obj: EndpointUpdateContext) => Promise<void>, name?: string, createIfNotExists?: boolean): IResourceWithEndpoints;
  withHttpHealthCheck(
      path?: string,
      statusCode?: number,
      endpointName?: string): IResourceWithEndpoints;
  withHttpProbe(
      probeType: ProbeType,
      path?: string,
      initialDelaySeconds?: number,
      periodSeconds?: number,
      timeoutSeconds?: number,
      failureThreshold?: number,
      successThreshold?: number,
      endpointName?: string): IResourceWithEndpoints;
  withHttpsEndpoint(
      port?: number,
      targetPort?: number,
      name?: string,
      env?: string,
      isProxied?: boolean): IResourceWithEndpoints;
  withHttpsEndpointCallback(callback: (obj: EndpointUpdateContext) => Promise<void>, name?: string, createIfNotExists?: boolean): IResourceWithEndpoints;
  withMcpServer(
      path?: string,
      endpointName?: string): IResourceWithEndpoints;
}

15 members

Methods

method asHttp2Service builder

Configures a resource to mark all endpoints' transport as HTTP/2. This is useful for HTTP/2 services that need prior knowledge.

asHttp2Service(): IResourceWithEndpoints

Returns

IResourceWithEndpoints

method getEndpoint

Gets an endpoint reference

getEndpoint(name: string): EndpointReference

Parameters

name string

Returns

EndpointReference

method onResourceEndpointsAllocated builder

Subscribes to the ResourceEndpointsAllocated event.

onResourceEndpointsAllocated(callback: (arg: ResourceEndpointsAllocatedEvent) => Promise<void>): IResourceWithEndpoints

Parameters

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

Returns

IResourceWithEndpoints

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

Parameters

port number optional

targetPort number optional

scheme string optional

name string optional

env string optional

isProxied boolean optional

isExternal boolean optional

protocol ProtocolType optional

Returns

IResourceWithEndpoints

method withEndpointCallback builder

Updates a named endpoint via callback

withEndpointCallback(endpointName: string, callback: (obj: EndpointUpdateContext) => Promise<void>, createIfNotExists?: boolean): IResourceWithEndpoints

Parameters

endpointName string

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

createIfNotExists boolean optional = True

Returns

IResourceWithEndpoints

method withEndpointProxySupport builder

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: boolean): IResourceWithEndpoints

Parameters

proxyEnabled boolean

Returns

IResourceWithEndpoints

method withExternalHttpEndpoints builder

Marks existing http or https endpoints on a resource as external.

withExternalHttpEndpoints(): IResourceWithEndpoints

Returns

IResourceWithEndpoints

method withHttpCommand builder

Adds an HTTP resource command

withHttpCommand(
    path: string,
    displayName: string,
    options?: HttpCommandExportOptions): IResourceWithEndpoints

Parameters

path string

displayName string

options HttpCommandExportOptions optional

Returns

IResourceWithEndpoints

method withHttpEndpoint builder

Adds an HTTP endpoint

withHttpEndpoint(
    port?: number,
    targetPort?: number,
    name?: string,
    env?: string,
    isProxied?: boolean): IResourceWithEndpoints

Parameters

port number optional

targetPort number optional

name string optional

env string optional

isProxied boolean optional

Returns

IResourceWithEndpoints

method withHttpEndpointCallback builder

Updates an HTTP endpoint via callback

withHttpEndpointCallback(callback: (obj: EndpointUpdateContext) => Promise<void>, name?: string, createIfNotExists?: boolean): IResourceWithEndpoints

Parameters

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

name string optional

createIfNotExists boolean optional = True

Returns

IResourceWithEndpoints

method withHttpHealthCheck builder

Adds a health check to the resource which is mapped to a specific endpoint.

withHttpHealthCheck(
    path?: string,
    statusCode?: number,
    endpointName?: string): IResourceWithEndpoints

Parameters

path string optional

statusCode number optional

endpointName string optional

Returns

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

Parameters

probeType ProbeType

path string optional

initialDelaySeconds number optional

periodSeconds number optional

timeoutSeconds number optional

failureThreshold number optional

successThreshold number optional

endpointName string optional

Returns

IResourceWithEndpoints

method withHttpsEndpoint builder

Adds an HTTPS endpoint

withHttpsEndpoint(
    port?: number,
    targetPort?: number,
    name?: string,
    env?: string,
    isProxied?: boolean): IResourceWithEndpoints

Parameters

port number optional

targetPort number optional

name string optional

env string optional

isProxied boolean optional

Returns

IResourceWithEndpoints

method withHttpsEndpointCallback builder

Updates an HTTPS endpoint via callback

withHttpsEndpointCallback(callback: (obj: EndpointUpdateContext) => Promise<void>, name?: string, createIfNotExists?: boolean): IResourceWithEndpoints

Parameters

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

name string optional

createIfNotExists boolean optional = True

Returns

IResourceWithEndpoints

method withMcpServer builder

Marks the resource as hosting a Model Context Protocol (MCP) server on the specified endpoint.

withMcpServer(
    path?: string,
    endpointName?: string): IResourceWithEndpoints

Parameters

path string optional = /mcp

endpointName string optional

Returns

IResourceWithEndpoints