Class BackendDetails

The load balancing configuration details of a backend server.

BackendDetails

public class BackendDetails

[JsonProperty(PropertyName = "backup")]
public bool? Backup { get; set; }

Type	Description
bool?	Whether the load balancer should treat this server as a backup unit. If `true`, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy. Note: You cannot add a backend server marked as `backup` to a backend set that uses the IP Hash policy. Example: false

[JsonProperty(PropertyName = "drain")]
public bool? Drain { get; set; }

Type	Description
bool?	Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic. Example: false

[Required(ErrorMessage = "IpAddress is required.")]
[JsonProperty(PropertyName = "ipAddress")]
public string IpAddress { get; set; }

Type	Description
string	The IP address of the backend server. Example: 10.0.0.3

Required

[JsonProperty(PropertyName = "maxConnections")]
public int? MaxConnections { get; set; }

Type	Description
int?	The maximum number of simultaneous connections the load balancer can make to the backend. If this is not set or set to 0 then the maximum number of simultaneous connections the load balancer can make to the backend is unlimited. If setting maxConnections to some value other than 0 then that value must be greater or equal to 256. Example: 300

[JsonProperty(PropertyName = "offline")]
public bool? Offline { get; set; }

Type	Description
bool?	Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic. Example: false

[Required(ErrorMessage = "Port is required.")]
[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }

Type	Description
int?	The communication port for the backend server. Example: 8080

Required

[JsonProperty(PropertyName = "weight")]
public int? Weight { get; set; }

Type	Description
int?	The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work. Example: 3