EndpointReference Constructors

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Hosting
5. /EndpointReference
6. /Constructors

ClassConstructors4 members

Represents an endpoint reference for a resource with endpoints.

Constructor(IResourceWithEndpoints, EndpointAnnotation, NetworkIdentifier?)

Creates a new instance of EndpointReference with the specified endpoint name.

public sealed class EndpointReference
{
    public EndpointReference(
        IResourceWithEndpoints owner,
        EndpointAnnotation endpoint,
        NetworkIdentifier? contextNetworkId)
    {
        // ...
    }
}

EndpointReference.cs#L262-L271

Parameters

ownerIResourceWithEndpointsThe resource with endpoints that owns the referenced endpoint.

endpointEndpointAnnotationThe endpoint annotation.

contextNetworkIdNetworkIdentifier?The ID of the network that serves as the context for the EndpointReference.

Remarks

Most Aspire resources are accessed in the context of the "localhost" network (host processes calling other host processes, or host processes calling container via mapped ports). If a NetworkIdentifier is specified, the EndpointReference will always resolve in the context of that network. If the NetworkIdentifier is null, the reference will attempt to resolve itself based on the context of the requesting resource.

Constructor(IResourceWithEndpoints, EndpointAnnotation)

Creates a new instance of EndpointReference with the specified endpoint name.

public sealed class EndpointReference
{
    public EndpointReference(
        IResourceWithEndpoints owner,
        EndpointAnnotation endpoint)
    {
        // ...
    }
}

EndpointReference.cs#L278-L280

Parameters

ownerIResourceWithEndpointsThe resource with endpoints that owns the referenced endpoint.

endpointEndpointAnnotationThe endpoint annotation.

Constructor(IResourceWithEndpoints, string, NetworkIdentifier?)

Creates a new instance of EndpointReference with the specified endpoint name.

public sealed class EndpointReference
{
    public EndpointReference(
        IResourceWithEndpoints owner,
        string endpointName,
        NetworkIdentifier? contextNetworkId = null)
    {
        // ...
    }
}

EndpointReference.cs#L294-L302

Parameters

ownerIResourceWithEndpointsThe resource with endpoints that owns the referenced endpoint.

endpointNamestringThe name of the endpoint.

contextNetworkIdNetworkIdentifier?optionalThe ID of the network that serves as the context for the EndpointReference.

Remarks

Most Aspire resources are accessed in the context of the "localhost" network (host proceses calling other host processes, or host processes calling container via mapped ports). This is why EndpointReference assumes this context unless specified otherwise. However, for container-to-container, or container-to-host communication, you must specify a container network context for the EndpointReference to be resolved correctly.

Constructor(IResourceWithEndpoints, string)

Creates a new instance of EndpointReference with the specified endpoint name.

public sealed class EndpointReference
{
    public EndpointReference(
        IResourceWithEndpoints owner,
        string endpointName)
    {
        // ...
    }
}

EndpointReference.cs#L309-L311

Parameters

ownerIResourceWithEndpointsThe resource with endpoints that owns the referenced endpoint.

endpointNamestringThe name of the endpoint.