EndpointReference
Class sealed net8.0
Represents an endpoint reference for a resource with endpoints.
namespace Aspire.Hosting.ApplicationModel;
public sealed class EndpointReference : Aspire.Hosting.ApplicationModel.IExpressionValue, Aspire.Hosting.ApplicationModel.IManifestExpressionProvider, Aspire.Hosting.ApplicationModel.IValueProvider, Aspire.Hosting.ApplicationModel.IValueWithReferences{ // ...} 25 members
Constructors4
Section titled ConstructorsEndpointReference(IResourceWithEndpoints, EndpointAnnotation, NetworkIdentifier?) Creates a new instance of
EndpointReference with the specified endpoint name. EndpointReference(IResourceWithEndpoints, EndpointAnnotation) Creates a new instance of
EndpointReference with the specified endpoint name. EndpointReference(IResourceWithEndpoints, string, NetworkIdentifier?) Creates a new instance of
EndpointReference with the specified endpoint name. EndpointReference(IResourceWithEndpoints, string) Creates a new instance of
EndpointReference with the specified endpoint name. Properties17
Section titled PropertiesContextNetworkIDget The ID of the network that serves as the context for the EndpointReference. The reference will be resolved in the context of this network, which may be different from the network associated with the default network of the referenced Endpoint.
EndpointAnnotationget Gets the endpoint annotation associated with the endpoint reference.
EndpointNamegetstring Gets the name of the endpoint associated with the endpoint reference.
ErrorMessageget; initstring? Gets or sets a custom error message to be thrown when the endpoint annotation is not found.
ExcludeReferenceEndpointgetbool Gets a value indicating whether this endpoint is excluded from the default set when referencing the resource's endpoints.
Existsgetbool Gets a value indicating whether the endpoint exists.
Hostgetstring Gets the host for this endpoint.
IsAllocatedgetbool Gets a value indicating whether the endpoint is allocated.
IsHttpgetbool Gets a value indicating whether the endpoint uses HTTP scheme.
IsHttpsgetbool Gets a value indicating whether the endpoint uses HTTPS scheme.
IsHttpSchemeNamedEndpointgetbool 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.
Portgetint Gets the port for this endpoint.
Resourceget Gets the resource owner of the endpoint reference.
Schemegetstring Gets the scheme for this endpoint.
TargetPortgetint? Gets the target port for this endpoint. If the port is dynamically allocated, this will return
null. TlsEnabledgetbool Gets a value indicating whether TLS is enabled for this endpoint.
Urlgetstring Gets the URL for this endpoint.
Methods4
Section titled MethodsGetTlsValue(ReferenceExpression, ReferenceExpression)ats export Creates a conditional
ReferenceExpression that resolves to enabledValue when EndpointAnnotation.TlsEnabled is true on this endpoint, or to disabledValue otherwise. GetValueAsync(CancellationToken)ats exportValueTask<string?> Gets the URL of the endpoint asynchronously. Waits for the endpoint to be allocated if necessary.
GetValueAsync(ValueProviderContext, CancellationToken)ats ignoredValueTask<string?> Gets the URL of the endpoint asynchronously. Waits for the endpoint to be allocated if necessary.
Property(EndpointProperty)ats export Gets the specified property expression of the endpoint.