Skip to content
Docs Try Aspire

EndpointReference Properties

Class Properties 14 members
Represents an endpoint reference for a resource with endpoints.
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.
public NetworkIdentifier? ContextNetworkID { get; }
Gets the endpoint annotation associated with the endpoint reference.
public EndpointAnnotation EndpointAnnotation { get; }
EndpointName Section titled EndpointName string
Gets the name of the endpoint associated with the endpoint reference.
public string EndpointName { get; }
ErrorMessage Section titled ErrorMessage nullable string?
Gets or sets a custom error message to be thrown when the endpoint annotation is not found.
public string? ErrorMessage { get; init; }
Gets a value indicating whether the endpoint exists.
public bool Exists { get; }
Gets the host for this endpoint.
public string Host { get; }
Gets a value indicating whether the endpoint is allocated.
public bool IsAllocated { get; }
Gets a value indicating whether the endpoint uses HTTP scheme.
public bool IsHttp { get; }
public bool IsHttps { get; }
Gets the port for this endpoint.
public int Port { get; }
Gets the resource owner of the endpoint reference.
public IResourceWithEndpoints Resource { get; }
Gets the scheme for this endpoint.
public string Scheme { get; }
TargetPort Section titled TargetPort nullable int?
Gets the target port for this endpoint. If the port is dynamically allocated, this will return null.
public int? TargetPort { get; }
Gets the URL for this endpoint.
public string Url { get; }