Share via

LoadBalancingRule Class

  • Reference

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.models._models_py3.SubResource
LoadBalancingRule

Constructor

LoadBalancingRule(*, id: str | None = None, name: str | None = None, frontend_ip_configuration: _models.SubResource | None = None, backend_address_pool: _models.SubResource | None = None, backend_address_pools: List[_models.SubResource] | None = None, probe: _models.SubResource | None = None, protocol: str | _models.TransportProtocol | None = None, load_distribution: str | _models.LoadDistribution | None = None, frontend_port: int | None = None, backend_port: int | None = None, idle_timeout_in_minutes: int | None = None, enable_floating_ip: bool | None = None, enable_tcp_reset: bool | None = None, disable_outbound_snat: bool | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
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.
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.
backend_address_pools
list[SubResource]

An array of references to pool of DIPs.
probe
SubResource

The reference to 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. Known values are: "Udp", "Tcp", and "All".
load_distribution
str or LoadDistribution

The load distribution policy for this rule. Known values are: "Default", "SourceIP", and "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

Name Description
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.
type
str

Type of the resource.
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.
backend_address_pools
list[SubResource]

An array of references to pool of DIPs.
probe
SubResource

The reference to 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. Known values are: "Udp", "Tcp", and "All".
load_distribution
str or LoadDistribution

The load distribution policy for this rule. Known values are: "Default", "SourceIP", and "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.
provisioning_state
str or ProvisioningState

The provisioning state of the load balancing rule resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed".