EndpointReference

Handle

📦 Aspire.Hosting v13.4.0

interface EndpointReference
  extends IExpressionValue,
    IManifestExpressionProvider,
    IValueProvider,
    IValueWithReferences {
  readonly endpointName: string;
  readonly 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;
}

18 members

Properties

property endpointName string get

Gets the name of the endpoint associated with the endpoint reference.

property errorMessage string get

Gets or sets a custom error message to be thrown when the endpoint annotation is not found.

property excludeReferenceEndpoint boolean get

Gets a value indicating whether this endpoint is excluded from the default set when referencing the resource's endpoints.

property exists boolean get

Gets a value indicating whether the endpoint exists.

property host string get

Gets the host for this endpoint.

property isAllocated boolean get

Gets a value indicating whether the endpoint is allocated.

property isHttp boolean get

Gets a value indicating whether the endpoint uses HTTP scheme.

property isHttps boolean get

Gets a value indicating whether the endpoint uses HTTPS scheme.

property isHttpSchemeNamedEndpoint boolean get

Gets a value indicating whether the endpoint name is "http" or "https", ignoring case. This is a convention used to identify endpoints that will be resolved based on the scheme of the endpoint in service discovery rather than by the specific endpoint name. This is done to allow http endpoints that are dynamically updated to https to be mapped correctly despite the endpoint name no longer matching the scheme.

property port number get

Gets the port for this endpoint.

property resource IResourceWithEndpoints get

Gets the resource owner of the endpoint reference.

property scheme string get

Gets the scheme for this endpoint.

property targetPort number get

Gets the target port for this endpoint. If the port is dynamically allocated, this will return `null`.

property tlsEnabled boolean get

Gets a value indicating whether TLS is enabled for this endpoint.

property url string get

Gets the URL for this endpoint.

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. Waits for the endpoint to be allocated if necessary.

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