LoadBalancingRuleInner Class

Package:

com.azure.resourcemanager.network.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.45.0

• java.lang.Object
• • com.azure.core.management.SubResource
  • • com.azure.resourcemanager.network.fluent.models.LoadBalancingRuleInner

public final class LoadBalancingRuleInner
extends SubResource

A load balancing rule for a load balancer.

Constructor Summary

Constructor	Description
LoadBalancingRuleInner()	Creates an instance of LoadBalancingRuleInner class.

Method Summary

Modifier and Type	Method and Description
SubResource	backendAddressPool() Get the backendAddressPool property: A reference to a pool of DIPs.
List<SubResource>	backendAddressPools() Get the backendAddressPools property: An array of references to pool of DIPs.
Integer	backendPort() Get the backendPort property: The port used for internal connections on the endpoint.
Boolean	disableOutboundSnat() Get the disableOutboundSnat property: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
Boolean	enableFloatingIp() Get the enableFloatingIp property: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group.
Boolean	enableTcpReset() Get the enableTcpReset property: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination.
String	etag() Get the etag property: A unique read-only string that changes whenever the resource is updated.
static LoadBalancingRuleInner	fromJson(JsonReader jsonReader) Reads an instance of LoadBalancingRuleInner from the JsonReader.
SubResource	frontendIpConfiguration() Get the frontendIpConfiguration property: A reference to frontend IP addresses.
Integer	frontendPort() Get the frontendPort property: The port for the external endpoint.
Integer	idleTimeoutInMinutes() Get the idleTimeoutInMinutes property: The timeout for the TCP idle connection.
LoadDistribution	loadDistribution() Get the loadDistribution property: The load distribution policy for this rule.
String	name() Get the name property: The name of the resource that is unique within the set of load balancing rules used by the load balancer.
SubResource	probe() Get the probe property: The reference to the load balancer probe used by the load balancing rule.
TransportProtocol	protocol() Get the protocol property: The reference to the transport protocol used by the load balancing rule.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the load balancing rule resource.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of the resource.
void	validate() Validates the instance.
LoadBalancingRuleInner	withBackendAddressPool(SubResource backendAddressPool) Set the backendAddressPool property: A reference to a pool of DIPs.
LoadBalancingRuleInner	withBackendAddressPools(List<SubResource> backendAddressPools) Set the backendAddressPools property: An array of references to pool of DIPs.
LoadBalancingRuleInner	withBackendPort(Integer backendPort) Set the backendPort property: The port used for internal connections on the endpoint.
LoadBalancingRuleInner	withDisableOutboundSnat(Boolean disableOutboundSnat) Set the disableOutboundSnat property: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
LoadBalancingRuleInner	withEnableFloatingIp(Boolean enableFloatingIp) Set the enableFloatingIp property: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group.
LoadBalancingRuleInner	withEnableTcpReset(Boolean enableTcpReset) Set the enableTcpReset property: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination.
LoadBalancingRuleInner	withFrontendIpConfiguration(SubResource frontendIpConfiguration) Set the frontendIpConfiguration property: A reference to frontend IP addresses.
LoadBalancingRuleInner	withFrontendPort(Integer frontendPort) Set the frontendPort property: The port for the external endpoint.
LoadBalancingRuleInner	withId(String id)
LoadBalancingRuleInner	withIdleTimeoutInMinutes(Integer idleTimeoutInMinutes) Set the idleTimeoutInMinutes property: The timeout for the TCP idle connection.
LoadBalancingRuleInner	withLoadDistribution(LoadDistribution loadDistribution) Set the loadDistribution property: The load distribution policy for this rule.
LoadBalancingRuleInner	withName(String name) Set the name property: The name of the resource that is unique within the set of load balancing rules used by the load balancer.
LoadBalancingRuleInner	withProbe(SubResource probe) Set the probe property: The reference to the load balancer probe used by the load balancing rule.
LoadBalancingRuleInner	withProtocol(TransportProtocol protocol) Set the protocol property: The reference to the transport protocol used by the load balancing rule.

Methods inherited from SubResource

fromJson id toJson withId

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LoadBalancingRuleInner

public LoadBalancingRuleInner()

Creates an instance of LoadBalancingRuleInner class.

Method Details

backendAddressPool

public SubResource backendAddressPool()

Get the backendAddressPool property: A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

Returns:

the backendAddressPool value.

backendAddressPools

public List backendAddressPools()

Get the backendAddressPools property: An array of references to pool of DIPs.

Returns:

the backendAddressPools value.

backendPort

public Integer backendPort()

Get the backendPort property: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".

Returns:

the backendPort value.

disableOutboundSnat

public Boolean disableOutboundSnat()

Get the disableOutboundSnat property: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

Returns:

the disableOutboundSnat value.

enableFloatingIp

public Boolean enableFloatingIp()

Get the enableFloatingIp property: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Returns:

the enableFloatingIp value.

enableTcpReset

public Boolean enableTcpReset()

Get the enableTcpReset property: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Returns:

the enableTcpReset value.

etag

public String etag()

Get the etag property: A unique read-only string that changes whenever the resource is updated.

Returns:

the etag value.

fromJson

public static LoadBalancingRuleInner fromJson(JsonReader jsonReader)

Reads an instance of LoadBalancingRuleInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of LoadBalancingRuleInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the LoadBalancingRuleInner.

frontendIpConfiguration

public SubResource frontendIpConfiguration()

Get the frontendIpConfiguration property: A reference to frontend IP addresses.

Returns:

the frontendIpConfiguration value.

frontendPort

public Integer frontendPort()

Get the frontendPort property: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".

Returns:

the frontendPort value.

idleTimeoutInMinutes

public Integer idleTimeoutInMinutes()

Get the idleTimeoutInMinutes property: The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Returns:

the idleTimeoutInMinutes value.

loadDistribution

public LoadDistribution loadDistribution()

Get the loadDistribution property: The load distribution policy for this rule.

Returns:

the loadDistribution value.

name

public String name()

Get the name property: The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.

Returns:

the name value.

probe

public SubResource probe()

Get the probe property: The reference to the load balancer probe used by the load balancing rule.

Returns:

the probe value.

protocol

public TransportProtocol protocol()

Get the protocol property: The reference to the transport protocol used by the load balancing rule.

Returns:

the protocol value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the load balancing rule resource.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

LoadBalancingRuleInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of the resource.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withBackendAddressPool

public LoadBalancingRuleInner withBackendAddressPool(SubResource backendAddressPool)

Set the backendAddressPool property: A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.

Parameters:

backendAddressPool - the backendAddressPool value to set.

Returns:

the LoadBalancingRuleInner object itself.

withBackendAddressPools

public LoadBalancingRuleInner withBackendAddressPools(List backendAddressPools)

Set the backendAddressPools property: An array of references to pool of DIPs.

Parameters:

backendAddressPools - the backendAddressPools value to set.

Returns:

the LoadBalancingRuleInner object itself.

withBackendPort

public LoadBalancingRuleInner withBackendPort(Integer backendPort)

Set the backendPort property: The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".

Parameters:

backendPort - the backendPort value to set.

Returns:

the LoadBalancingRuleInner object itself.

withDisableOutboundSnat

public LoadBalancingRuleInner withDisableOutboundSnat(Boolean disableOutboundSnat)

Set the disableOutboundSnat property: Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.

Parameters:

disableOutboundSnat - the disableOutboundSnat value to set.

Returns:

the LoadBalancingRuleInner object itself.

withEnableFloatingIp

public LoadBalancingRuleInner withEnableFloatingIp(Boolean enableFloatingIp)

Set the enableFloatingIp property: Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint.

Parameters:

enableFloatingIp - the enableFloatingIp value to set.

Returns:

the LoadBalancingRuleInner object itself.

withEnableTcpReset

public LoadBalancingRuleInner withEnableTcpReset(Boolean enableTcpReset)

Set the enableTcpReset property: Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP.

Parameters:

enableTcpReset - the enableTcpReset value to set.

Returns:

the LoadBalancingRuleInner object itself.

withFrontendIpConfiguration

public LoadBalancingRuleInner withFrontendIpConfiguration(SubResource frontendIpConfiguration)

Set the frontendIpConfiguration property: A reference to frontend IP addresses.

Parameters:

frontendIpConfiguration - the frontendIpConfiguration value to set.

Returns:

the LoadBalancingRuleInner object itself.

withFrontendPort

public LoadBalancingRuleInner withFrontendPort(Integer frontendPort)

Set the frontendPort property: The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port".

Parameters:

frontendPort - the frontendPort value to set.

Returns:

the LoadBalancingRuleInner object itself.

withId

public LoadBalancingRuleInner withId(String id)

Overrides:

LoadBalancingRuleInner.withId(String id)

Parameters:

id

withIdleTimeoutInMinutes

public LoadBalancingRuleInner withIdleTimeoutInMinutes(Integer idleTimeoutInMinutes)

Set the idleTimeoutInMinutes property: The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP.

Parameters:

idleTimeoutInMinutes - the idleTimeoutInMinutes value to set.

Returns:

the LoadBalancingRuleInner object itself.

withLoadDistribution

public LoadBalancingRuleInner withLoadDistribution(LoadDistribution loadDistribution)

Set the loadDistribution property: The load distribution policy for this rule.

Parameters:

loadDistribution - the loadDistribution value to set.

Returns:

the LoadBalancingRuleInner object itself.

withName

public LoadBalancingRuleInner withName(String name)

Set the name property: The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource.

Parameters:

name - the name value to set.

Returns:

the LoadBalancingRuleInner object itself.

withProbe

public LoadBalancingRuleInner withProbe(SubResource probe)

Set the probe property: The reference to the load balancer probe used by the load balancing rule.

Parameters:

probe - the probe value to set.

Returns:

the LoadBalancingRuleInner object itself.

withProtocol

public LoadBalancingRuleInner withProtocol(TransportProtocol protocol)

Set the protocol property: The reference to the transport protocol used by the load balancing rule.

Parameters:

protocol - the protocol value to set.

Returns:

the LoadBalancingRuleInner object itself.