Share via

LoadBalancingRule interface

Package:
@azure/arm-network-profile-2020-09-01-hybrid

A load balancing rule for a load balancer.

Extends
SubResource

Properties

backendAddressPool

A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
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.
etag

A unique read-only string that changes whenever the resource is updated.
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. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.
name

The name of the resource that is unique within a resource group. This name can be used to access the resource.
probe

The reference of the load balancer probe used by the load balancing rule.
protocol

The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'.
provisioningState

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Inherited Properties

id

Resource ID.

Property Details

backendAddressPool

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

backendAddressPool?: SubResource

Property Value

SubResource

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

etag

A unique read-only string that changes whenever the resource is updated.

etag?: string

Property Value

string

frontendIPConfiguration

A reference to frontend IP addresses.

frontendIPConfiguration?: SubResource

Property Value

SubResource

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. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.

loadDistribution?: string

Property Value

string

name

The name of the resource that is unique within a resource group. This name can be used to access the resource.

name?: string

Property Value

string

probe

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

probe?: SubResource

Property Value

SubResource

protocol

The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'.

protocol?: string

Property Value

string

provisioningState

Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

provisioningState?: string

Property Value

string

Inherited Property Details

id

Resource ID.

id?: string

Property Value

string

Inherited From SubResource.id