IResourceWithEndpoints.withEndpoint

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting
5. /IResourceWithEndpoints
6. /withEndpoint

Method

📦 Aspire.Hosting v13.6.0

interface IResourceWithEndpoints {
  // ... omitted for brevity
  withEndpoint(
      port?: number,
      targetPort?: number,
      scheme?: string,
      name?: string,
      env?: string,
      isProxied?: boolean,
      isExternal?: boolean,
      protocol?: ProtocolType): IResourceWithEndpoints;
}

Signature

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

Defined on

This method is defined on the following type:

interfaceIResourceWithEndpoints15 members