EndpointReference

Handle

📦 Aspire.Hosting v13.3.0

interface EndpointReference
  extends IExpressionValue,
    IManifestExpressionProvider,
    IValueProvider,
    IValueWithReferences {
  readonly endpointName: string;
  errorMessage: string;
  readonly excludeReferenceEndpoint: boolean;
  readonly exists: boolean;
  readonly host: string;
  readonly isAllocated: boolean;
  readonly isHttp: boolean;
  readonly isHttps: boolean;
  readonly isHttpSchemeNamedEndpoint: boolean;
  readonly port: number;
  readonly resource: IResourceWithEndpoints;
  readonly scheme: string;
  readonly targetPort: number;
  readonly tlsEnabled: boolean;
  readonly url: string;
  getTlsValue(
      enabledValue: ReferenceExpression,
      disabledValue: ReferenceExpression): ReferenceExpression;
  getValueAsync(cancellationToken?: cancellationToken): string;
  property(property: EndpointProperty): EndpointReferenceExpression;
}

19 members

Properties

property endpointName string get

Gets the EndpointName property

property errorMessage string get · set

Gets the ErrorMessage property

property excludeReferenceEndpoint boolean get

Gets the ExcludeReferenceEndpoint property

property exists boolean get

Gets the Exists property

property host string get

Gets the Host property

property isAllocated boolean get

Gets the IsAllocated property

property isHttp boolean get

Gets the IsHttp property

property isHttps boolean get

Gets the IsHttps property

property isHttpSchemeNamedEndpoint boolean get

Gets the IsHttpSchemeNamedEndpoint property

property port number get

Gets the Port property

property resource IResourceWithEndpoints get

Gets the Resource property

property scheme string get

Gets the Scheme property

property targetPort number get

Gets the TargetPort property

property tlsEnabled boolean get

Gets the TlsEnabled property

property url string get

Gets the Url property

Methods

method getTlsValue

Gets a conditional expression that resolves to the enabledValue when TLS is enabled on the endpoint, or to the disabledValue otherwise.

getTlsValue(
    enabledValue: ReferenceExpression,
    disabledValue: ReferenceExpression): ReferenceExpression

Parameters

enabledValue ReferenceExpression

disabledValue ReferenceExpression

Returns

ReferenceExpression

method getValueAsync

Gets the URL of the endpoint asynchronously

getValueAsync(cancellationToken?: cancellationToken): string

Parameters

cancellationToken cancellationToken optional

Returns

string

method property

Gets the specified property expression of the endpoint

property(property: EndpointProperty): EndpointReferenceExpression

Parameters

property EndpointProperty

Returns

EndpointReferenceExpression