IResourceWithEndpoints

Interface

📦 Aspire.Hosting v13.6.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

methodasHttp2Servicebuilder

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

methodgetEndpoint

Gets an endpoint reference

getEndpoint(name: string): EndpointReference

Parameters

namestring

Returns

EndpointReference

methodonResourceEndpointsAllocatedbuilder

Subscribes to the ResourceEndpointsAllocated event.

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

Parameters

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

Returns

IResourceWithEndpoints

methodwithEndpointbuilder

Adds a network endpoint

withEndpoint(
    port?: number,
    targetPort?: number,
    scheme?: string,
    name?: string,
    env?: string,
    isProxied?: boolean,
    isExternal?: boolean,
    protocol?: ProtocolType): IResourceWithEndpoints

Parameters

portnumberoptional

targetPortnumberoptional

schemestringoptional

namestringoptional

envstringoptional

isProxiedbooleanoptional

isExternalbooleanoptional

protocolProtocolTypeoptional

Returns

IResourceWithEndpoints

methodwithEndpointCallbackbuilder

Updates a named endpoint via callback

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

Parameters

endpointNamestring

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

createIfNotExistsbooleanoptional= True

Returns

IResourceWithEndpoints

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

Parameters

proxyEnabledboolean

Returns

IResourceWithEndpoints

methodwithExternalHttpEndpointsbuilder

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

withExternalHttpEndpoints(): IResourceWithEndpoints

Returns

IResourceWithEndpoints

methodwithHttpCommandbuilder

Adds an HTTP resource command

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

Parameters

pathstring

displayNamestring

optionsHttpCommandExportOptionsoptional

Returns

IResourceWithEndpoints

methodwithHttpEndpointbuilder

Adds an HTTP endpoint

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

Parameters

portnumberoptional

targetPortnumberoptional

namestringoptional

envstringoptional

isProxiedbooleanoptional

Returns

IResourceWithEndpoints

methodwithHttpEndpointCallbackbuilder

Updates an HTTP endpoint via callback

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

Parameters

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

namestringoptional

createIfNotExistsbooleanoptional= True

Returns

IResourceWithEndpoints

methodwithHttpHealthCheckbuilder

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

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

Parameters

pathstringoptional

statusCodenumberoptional

endpointNamestringoptional

Returns

IResourceWithEndpoints

methodwithHttpProbebuilder

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

probeTypeProbeType

pathstringoptional

initialDelaySecondsnumberoptional

periodSecondsnumberoptional

timeoutSecondsnumberoptional

failureThresholdnumberoptional

successThresholdnumberoptional

endpointNamestringoptional

Returns

IResourceWithEndpoints

methodwithHttpsEndpointbuilder

Adds an HTTPS endpoint

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

Parameters

portnumberoptional

targetPortnumberoptional

namestringoptional

envstringoptional

isProxiedbooleanoptional

Returns

IResourceWithEndpoints

methodwithHttpsEndpointCallbackbuilder

Updates an HTTPS endpoint via callback

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

Parameters

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

namestringoptional

createIfNotExistsbooleanoptional= True

Returns

IResourceWithEndpoints

methodwithMcpServerbuilder

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

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

Parameters

pathstringoptional= /mcp

endpointNamestringoptional

Returns

IResourceWithEndpoints