Skip to content
Docs Try Aspire

EndpointAnnotation Properties

Class Properties 13 members
Represents an endpoint annotation that describes how a service should be bound to a network.
Gets the list of all AllocatedEndpoints associated with this Endpoint.
public NetworkEndpointSnapshotList AllAllocatedEndpoints { get; }
Gets or sets the default EndpointAnnotation.AllocatedEndpoint for this Endpoint.
public AllocatedEndpoint? AllocatedEndpoint { get; set; }
AllocatedEndpointSnapshot Section titled AllocatedEndpointSnapshot ValueSnapshot<AllocatedEndpoint>
public ValueSnapshot<AllocatedEndpoint> AllocatedEndpointSnapshot { get; }
Gets the ID of the network that is the "default" network for the Endpoint (the one the Endpoint is associated with and can be reached without routing or network address translation).
public NetworkIdentifier DefaultNetworkID { get; }
Indicates that this endpoint should be exposed externally at publish time.
public bool IsExternal { get; set; }
Indicates that this endpoint should be managed by DCP. This means it can be replicated and use a different port internally than the one publicly exposed. Setting to false means the endpoint will be handled and exposed by the resource.
public bool IsProxied { get; set; }
Defaults to true.
Name of the service
public string Name { get; set; }
Port Section titled Port nullable int?
Desired port for the service
public int? Port { get; set; }
Protocol Section titled Protocol ProtocolType
Network protocol: TCP or UDP are supported today, others possibly in future.
public ProtocolType Protocol { get; set; }
TargetHost Section titled TargetHost string
This is the address the resource is listening on. By default it is localhost.
public string TargetHost { get; set; }
TargetPort Section titled TargetPort nullable int?
This is the port the resource is listening on. If the endpoint is used for the container, it is the container port.
public int? TargetPort { get; set; }
Transport that is being used (e.g. http, http2, http3 etc).
public string Transport { get; set; }
If a service is URI-addressable, this property will contain the URI scheme to use for constructing service URI.
public string UriScheme { get; set; }