LoadBalancingRulePropertiesFormatOutput interface

Package:

@azure-rest/arm-network

Properties of the load balancer.

Properties

backendAddressPool	A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
backendAddressPools	An array of references to pool of DIPs.
backendPort	The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".
disableOutboundSnat	Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
enableFloatingIP	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.
enableTcpReset	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.
frontendIPConfiguration	A reference to frontend IP addresses.
frontendPort	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".
idleTimeoutInMinutes	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.
loadDistribution	The load distribution policy for this rule.
probe	The reference to the load balancer probe used by the load balancing rule.
protocol	The reference to the transport protocol used by the load balancing rule.
provisioningState	The provisioning state of the load balancing rule resource.

Property Details

backendAddressPool

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

backendAddressPool?: SubResourceOutput

Property Value

SubResourceOutput

backendAddressPools

An array of references to pool of DIPs.

backendAddressPools?: SubResourceOutput[]

Property Value

SubResourceOutput[]

backendPort

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

backendPort?: number

Property Value

number

disableOutboundSnat

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

disableOutboundSnat?: boolean

Property Value

boolean

enableFloatingIP

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.

enableFloatingIP?: boolean

Property Value

boolean

enableTcpReset

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.

enableTcpReset?: boolean

Property Value

boolean

frontendIPConfiguration

A reference to frontend IP addresses.

frontendIPConfiguration?: SubResourceOutput

Property Value

SubResourceOutput

frontendPort

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".

frontendPort: number

Property Value

number

idleTimeoutInMinutes

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.

idleTimeoutInMinutes?: number

Property Value

number

loadDistribution

The load distribution policy for this rule.

loadDistribution?: "Default" | "SourceIP" | "SourceIPProtocol"

Property Value

"Default" | "SourceIP" | "SourceIPProtocol"

probe

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

probe?: SubResourceOutput

Property Value

SubResourceOutput

protocol

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

protocol: "Tcp" | "Udp" | "All"

Property Value

"Tcp" | "Udp" | "All"

provisioningState

The provisioning state of the load balancing rule resource.

provisioningState?: "Succeeded" | "Updating" | "Deleting" | "Failed"

Property Value

"Succeeded" | "Updating" | "Deleting" | "Failed"