Skip to content
Docs Try Aspire
Docs Try

EndpointAnnotation Constructors

Class Constructors 4 members
Represents an endpoint annotation that describes how a service should be bound to a network.
Constructor(ProtocolType, string?, string?, string?, int?, int?, bool?, bool?) Section titled Constructor(ProtocolType, string?, string?, string?, int?, int?, bool?, bool?)
Initializes a new instance of EndpointAnnotation.
public sealed class EndpointAnnotation
{
public EndpointAnnotation(
ProtocolType protocol,
string? uriScheme = null,
string? transport = null,
string? name = null,
int? port = null,
int? targetPort = null,
bool? isExternal = null,
bool? isProxied = null)
{
// ...
}
}
protocol ProtocolType Network protocol: TCP or UDP are supported today, others possibly in future.
uriScheme string? optional If a service is URI-addressable, this is the URI scheme to use for constructing service URI.
transport string? optional Transport that is being used (e.g. http, http2, http3 etc).
name string? optional Name of the service.
port int? optional Desired port for the service.
targetPort int? optional This is the port the resource is listening on. If the endpoint is used for the container, it is the container port.
isExternal bool? optional Indicates that this endpoint should be exposed externally at publish time.
isProxied bool? optional Specifies if the endpoint will be proxied by DCP. Defaults to null.
Constructor(ProtocolType, string?, string?, string?, int?, int?, bool?, bool) Section titled Constructor(ProtocolType, string?, string?, string?, int?, int?, bool?, bool)
Initializes a new instance of EndpointAnnotation.
public sealed class EndpointAnnotation
{
public EndpointAnnotation(
ProtocolType protocol,
string? uriScheme,
string? transport,
string? name,
int? port,
int? targetPort,
bool? isExternal,
bool isProxied)
{
// ...
}
}
protocol ProtocolType Network protocol: TCP or UDP are supported today, others possibly in future.
uriScheme string? If a service is URI-addressable, this is the URI scheme to use for constructing service URI.
transport string? Transport that is being used (e.g. http, http2, http3 etc).
name string? Name of the service.
port int? Desired port for the service.
targetPort int? This is the port the resource is listening on. If the endpoint is used for the container, it is the container port.
isExternal bool? Indicates that this endpoint should be exposed externally at publish time.
isProxied bool Specifies if the endpoint will be proxied by DCP.
Constructor(ProtocolType, NetworkIdentifier?, string?, string?, string?, int?, int?, bool?, bool?) Section titled Constructor(ProtocolType, NetworkIdentifier?, string?, string?, string?, int?, int?, bool?, bool?)
Initializes a new instance of EndpointAnnotation.
public sealed class EndpointAnnotation
{
public EndpointAnnotation(
ProtocolType protocol,
NetworkIdentifier? networkID,
string? uriScheme = null,
string? transport = null,
string? name = null,
int? port = null,
int? targetPort = null,
bool? isExternal = null,
bool? isProxied = null)
{
// ...
}
}
protocol ProtocolType Network protocol: TCP or UDP are supported today, others possibly in future.
networkID NetworkIdentifier? The ID of the network that is the "default" network for the Endpoint. Clients connected to the same network can reach the endpoint without any routing or network address translation.
uriScheme string? optional If a service is URI-addressable, this is the URI scheme to use for constructing service URI.
transport string? optional Transport that is being used (e.g. http, http2, http3 etc).
name string? optional Name of the service.
port int? optional Desired port for the service.
targetPort int? optional This is the port the resource is listening on. If the endpoint is used for the container, it is the container port.
isExternal bool? optional Indicates that this endpoint should be exposed externally at publish time.
isProxied bool? optional Specifies if the endpoint will be proxied by DCP. Defaults to null.
Constructor(ProtocolType, NetworkIdentifier?, string?, string?, string?, int?, int?, bool?, bool) Section titled Constructor(ProtocolType, NetworkIdentifier?, string?, string?, string?, int?, int?, bool?, bool)
Initializes a new instance of EndpointAnnotation.
public sealed class EndpointAnnotation
{
public EndpointAnnotation(
ProtocolType protocol,
NetworkIdentifier? networkID,
string? uriScheme,
string? transport,
string? name,
int? port,
int? targetPort,
bool? isExternal,
bool isProxied)
{
// ...
}
}
protocol ProtocolType Network protocol: TCP or UDP are supported today, others possibly in future.
networkID NetworkIdentifier? The ID of the network that is the "default" network for the Endpoint. Clients connected to the same network can reach the endpoint without any routing or network address translation.
uriScheme string? If a service is URI-addressable, this is the URI scheme to use for constructing service URI.
transport string? Transport that is being used (e.g. http, http2, http3 etc).
name string? Name of the service.
port int? Desired port for the service.
targetPort int? This is the port the resource is listening on. If the endpoint is used for the container, it is the container port.
isExternal bool? Indicates that this endpoint should be exposed externally at publish time.
isProxied bool Specifies if the endpoint will be proxied by DCP.