withEndpoint

Method

📦 Aspire.Hosting v13.4.0

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

isExternal boolean optional

protocol ProtocolType optional

Returns

IResourceWithEndpoints

Applies to

This method applies to the following types:

type ContainerResource

type ExecutableResource

type ProjectResource

type DotnetToolResource

type CSharpAppResource