Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LoadBalancingRule

Package version

A load balancing rule for a load balancer.

Hierarchy

Index

Properties

Optional backendAddressPool

backendAddressPool: SubResource

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

Optional backendPort

backendPort: undefined | number

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

Optional disableOutboundSnat

disableOutboundSnat: undefined | false | true

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

Optional enableFloatingIP

enableFloatingIP: undefined | false | true

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.

Optional etag

etag: undefined | string

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

Optional frontendIPConfiguration

frontendIPConfiguration: SubResource

A reference to frontend IP addresses.

frontendPort

frontendPort: number

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"

Optional id

id: undefined | string

Resource ID.

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

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.

Optional loadDistribution

loadDistribution: LoadDistribution

The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. Possible values include: 'Default', 'SourceIP', 'SourceIPProtocol'

Optional name

name: undefined | string

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

Optional probe

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

protocol

Possible values include: 'Udp', 'Tcp', 'All'

Optional provisioningState

provisioningState: undefined | string

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

Generated using TypeDoc