EndpointAnnotation Properties
Class Properties 14 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; } Gets the
EndpointAnnotation.AllocatedEndpointSnapshot for the default EndpointAnnotation.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; }Remarks
Defaults to
true. Network protocol: TCP or UDP are supported today, others possibly in future.
public ProtocolType Protocol { get; set; } This is the address the resource is listening on. By default it is localhost.
public string TargetHost { get; set; } 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; }Remarks
Defaults to
EndpointAnnotation.Port. Gets or sets a value indicating whether TLS is enabled for this endpoint.
public bool TlsEnabled { get; set; }Remarks
This property is used to track TLS state on the endpoint so that connection string expressions can dynamically include TLS-related parameters (e.g.,
ssl=true for Redis) at resolution time rather than at expression build time. For HTTP-based endpoints, the EndpointAnnotation.UriScheme property being set to https already implies TLS. This property is primarily useful for non-HTTP protocols (e.g., Redis, databases) that need explicit TLS configuration in their connection strings. 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; }