withEndpoint

Docs / Reference / Search TypeScript APIs / Aspire.Hosting / withEndpoint

withEndpoint

Docs Reference Search TypeScript APIs Aspire.Hosting withEndpoint

Function

📦 Aspire.Hosting v13.2.0-preview.1.26159.1

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

Signature

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

Applies to

This function is an extension method on the following types:

type ContainerResource

type ExecutableResource

type ProjectResource

type DotnetToolResource

type CSharpAppResource