Skip to content
Docs Try Aspire

EndpointReference Methods

Class Methods 4 members
Represents an endpoint reference for a resource with endpoints.
Creates a conditional ReferenceExpression that resolves to enabledValue when EndpointAnnotation.TlsEnabled is true on this endpoint, or to disabledValue otherwise.
public sealed class EndpointReference
{
public ReferenceExpression GetTlsValue(
ReferenceExpression enabledValue,
ReferenceExpression disabledValue)
{
// ...
}
}
enabledValue ReferenceExpression The expression to evaluate when TLS is enabled (e.g., ",ssl=true").
disabledValue ReferenceExpression The expression to evaluate when TLS is not enabled.
ReferenceExpression A conditional ReferenceExpression whose value tracks the TLS state of this endpoint.
The returned expression evaluates the TLS state lazily each time its value is resolved, making it safe to embed in a ReferenceExpression that is built before TLS is configured (e.g., before BeforeStartEvent fires). Because the condition and branches are declarative, polyglot code generators can translate this into native conditional constructs in any target language.
GetValueAsync(CancellationToken) Section titled GetValueAsync(CancellationToken) ValueTask<string?>
Gets the URL of the endpoint asynchronously. Waits for the endpoint to be allocated if necessary.
public sealed class EndpointReference
{
public ValueTask<string?> GetValueAsync(
CancellationToken cancellationToken = default(CancellationToken))
{
// ...
}
}
cancellationToken CancellationToken optional The cancellation token.
ValueTask<string?> The URL of the endpoint.
GetValueAsync(ValueProviderContext, CancellationToken) Section titled GetValueAsync(ValueProviderContext, CancellationToken) ValueTask<string?>
Gets the URL of the endpoint asynchronously. Waits for the endpoint to be allocated if necessary.
public sealed class EndpointReference
{
public ValueTask<string?> GetValueAsync(
ValueProviderContext context,
CancellationToken cancellationToken = default(CancellationToken))
{
// ...
}
}
context ValueProviderContext The context for value resolution.
cancellationToken CancellationToken optional The cancellation token.
ValueTask<string?> The URL of the endpoint.
Gets the specified property expression of the endpoint. Defaults to the URL if no property is specified.
public sealed class EndpointReference
{
public EndpointReferenceExpression Property(
EndpointProperty property)
{
// ...
}
}
property EndpointProperty The EndpointProperty enum value to use in the reference.