LoadBalancingRule Class

A load balancing rule for a load balancer.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.network.v2019_08_01.models._models_py3.SubResource

LoadBalancingRule

Constructor

LoadBalancingRule(*, id: typing.Union[str, NoneType] = None, name: typing.Union[str, NoneType] = None, etag: typing.Union[str, NoneType] = None, frontend_ip_configuration: typing.Union[_ForwardRef('SubResource'), NoneType] = None, backend_address_pool: typing.Union[_ForwardRef('SubResource'), NoneType] = None, probe: typing.Union[_ForwardRef('SubResource'), NoneType] = None, protocol: typing.Union[str, _ForwardRef('TransportProtocol'), NoneType] = None, load_distribution: typing.Union[str, _ForwardRef('LoadDistribution'), NoneType] = None, frontend_port: typing.Union[int, NoneType] = None, backend_port: typing.Union[int, NoneType] = None, idle_timeout_in_minutes: typing.Union[int, NoneType] = None, enable_floating_ip: typing.Union[bool, NoneType] = None, enable_tcp_reset: typing.Union[bool, NoneType] = None, disable_outbound_snat: typing.Union[bool, NoneType] = None, **kwargs)

Parameters

id

str

Resource ID.

name

str

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.

etag

str

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

frontend_ip_configuration

SubResource

A reference to frontend IP addresses.

backend_address_pool

SubResource

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

probe

SubResource

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

protocol

str or TransportProtocol

The reference to the transport protocol used by the load balancing rule. Possible values include: "Udp", "Tcp", "All".

load_distribution

str or LoadDistribution

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

frontend_port

int

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

backend_port

int

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

idle_timeout_in_minutes

int

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.

enable_floating_ip

bool

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.

enable_tcp_reset

bool

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.

disable_outbound_snat

bool

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

Variables

type

str

Type of the resource.

provisioning_state

str or ProvisioningState

The provisioning state of the load balancing rule resource. Possible values include: "Succeeded", "Updating", "Deleting", "Failed".