EndpointAnnotation Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an endpoint annotation that describes how a service should be bound to a network.
public sealed class EndpointAnnotation : Aspire.Hosting.ApplicationModel.IResourceAnnotationtype EndpointAnnotation = class
interface IResourceAnnotationPublic NotInheritable Class EndpointAnnotation
Implements IResourceAnnotation- Inheritance
-
EndpointAnnotation
- Implements
Remarks
This class is used to specify the network protocol, port, URI scheme, transport, and other details for a service.
Constructors
Properties
| AllAllocatedEndpoints |
Gets the list of all AllocatedEndpoints associated with this Endpoint. |
| AllocatedEndpoint |
Gets or sets the default AllocatedEndpoint for this Endpoint. |
| AllocatedEndpointSnapshot |
Gets the AllocatedEndpointSnapshot for the default AllocatedEndpoint. |
| DefaultNetworkID |
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). |
| IsExternal |
Indicates that this endpoint should be exposed externally at publish time. |
| IsProxied |
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. |
| Name |
Name of the service |
| Port |
Desired port for the service |
| Protocol |
Network protocol: TCP or UDP are supported today, others possibly in future. |
| TargetHost |
This is the address the resource is listening on. By default it is localhost. |
| TargetPort |
This is the port the resource is listening on. If the endpoint is used for the container, it is the container port. |
| Transport |
Transport that is being used (e.g. http, http2, http3 etc). |
| UriScheme |
If a service is URI-addressable, this property will contain the URI scheme to use for constructing service URI. |