IResourceWithEndpoints

Docs / Reference / TypeScript APIs / Aspire.Hosting.Maui / IResourceWithEndpoints

IResourceWithEndpoints

Docs Reference TypeScript APIs Aspire.Hosting.Maui IResourceWithEndpoints

Interface TypeScript

📦 Aspire.Hosting.Maui v13.2.0-preview.1.26159.1

interface IResourceWithEndpoints {
  asHttp2Service(): IResourceWithEndpoints;
  getEndpoint(name: string): EndpointReference;
  withEndpoint(
      port?: number,
      targetPort?: number,
      scheme?: string,
      name?: string,
      env?: string,
      isProxied?: boolean,
      isExternal?: boolean,
      protocol?: ProtocolType): IResourceWithEndpoints;
  withExternalHttpEndpoints(): IResourceWithEndpoints;
  withHttpEndpoint(
      port?: number,
      targetPort?: number,
      name?: string,
      env?: string,
      isProxied?: 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;
  withMcpServer(
      path?: string,
      endpointName?: string): IResourceWithEndpoints;
  withUrlForEndpointFactory(endpointName: string, callback: (arg: EndpointReference) => ResourceUrlAnnotation): IResourceWithEndpoints;
}

Search members of IResourceWithEndpoints…

method

10 members Clear filters

Methods

method asHttp2Service builder

Configures resource for HTTP/2

asHttp2Service(): IResourceWithEndpoints

Returns

IResourceWithEndpoints

method getEndpoint

Gets an endpoint reference

getEndpoint(name: string): EndpointReference

Parameters

name string

Returns

EndpointReference

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 = True

isExternal boolean optional

protocol ProtocolType optional

Returns

IResourceWithEndpoints

method withExternalHttpEndpoints builder

Makes HTTP endpoints externally accessible

withExternalHttpEndpoints(): IResourceWithEndpoints

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 = True

Returns

IResourceWithEndpoints

method withHttpHealthCheck builder

Adds an HTTP health check

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 = True

Returns

IResourceWithEndpoints

method withMcpServer builder

Configures an MCP server endpoint on the resource

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

Parameters

path string optional = /mcp

endpointName string optional

Returns

IResourceWithEndpoints

method withUrlForEndpointFactory builder

Adds a URL for a specific endpoint via factory callback

withUrlForEndpointFactory(endpointName: string, callback: (arg: EndpointReference) => ResourceUrlAnnotation): IResourceWithEndpoints

Parameters

endpointName string

callback (arg: EndpointReference) => ResourceUrlAnnotation

Returns

IResourceWithEndpoints