load_balancer_load_balancing_rules

Creates, updates, deletes, gets or lists a load_balancer_load_balancing_rules resource.

Overview

Name	load_balancer_load_balancing_rules
Type	Resource
Id	azure.network.load_balancer_load_balancing_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
backendAddressPool	object	Reference to another subresource.
backendAddressPools	array	An array of references to pool of DIPs.
backendPort	integer	The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".
disableOutboundSnat	boolean	Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
enableConnectionTracking	boolean	Defines whether connections between 2 communicating endpoints can be tracked and associated to the same backend VM over its lifetime when using UDP protocol.
enableFloatingIP	boolean	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	boolean	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	string	A unique read-only string that changes whenever the resource is updated.
frontendIPConfiguration	object	Reference to another subresource.
frontendPort	integer	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". Required.
idleTimeoutInMinutes	integer	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	string	The load distribution policy for this rule. Known values are: "Default", "SourceIP", and "SourceIPProtocol". (Default, SourceIP, SourceIPProtocol)
probe	object	Reference to another subresource.
protocol	string	The reference to the transport protocol used by the load balancing rule. Required. Known values are: "Udp", "Tcp", "All", and "Quic". (Udp, Tcp, All, Quic)
provisioningState	string	The provisioning state of the load balancing rule resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
backendAddressPool	object	Reference to another subresource.
backendAddressPools	array	An array of references to pool of DIPs.
backendPort	integer	The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port".
disableOutboundSnat	boolean	Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule.
enableConnectionTracking	boolean	Defines whether connections between 2 communicating endpoints can be tracked and associated to the same backend VM over its lifetime when using UDP protocol.
enableFloatingIP	boolean	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	boolean	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	string	A unique read-only string that changes whenever the resource is updated.
frontendIPConfiguration	object	Reference to another subresource.
frontendPort	integer	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". Required.
idleTimeoutInMinutes	integer	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	string	The load distribution policy for this rule. Known values are: "Default", "SourceIP", and "SourceIPProtocol". (Default, SourceIP, SourceIPProtocol)
probe	object	Reference to another subresource.
protocol	string	The reference to the transport protocol used by the load balancing rule. Required. Known values are: "Udp", "Tcp", "All", and "Quic". (Udp, Tcp, All, Quic)
provisioningState	string	The provisioning state of the load balancing rule resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, load_balancer_name, load_balancing_rule_name, subscription_id		Gets the specified load balancer load balancing rule.
list	select	resource_group_name, load_balancer_name, subscription_id		Gets all the load balancing rules in a load balancer.
health	exec	group_name, load_balancer_name, load_balancing_rule_name, subscription_id		Get health details of a load balancing rule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
group_name	string	Required.
load_balancer_name	string	The name of the load balancer. Required.
load_balancing_rule_name	string	The name of the load balancing rule. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified load balancer load balancing rule.

SELECT
id,
name,
backendAddressPool,
backendAddressPools,
backendPort,
disableOutboundSnat,
enableConnectionTracking,
enableFloatingIP,
enableTcpReset,
etag,
frontendIPConfiguration,
frontendPort,
idleTimeoutInMinutes,
loadDistribution,
probe,
protocol,
provisioningState,
type
FROM azure.network.load_balancer_load_balancing_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND load_balancing_rule_name = '{{ load_balancing_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the load balancing rules in a load balancer.

SELECT
id,
name,
backendAddressPool,
backendAddressPools,
backendPort,
disableOutboundSnat,
enableConnectionTracking,
enableFloatingIP,
enableTcpReset,
etag,
frontendIPConfiguration,
frontendPort,
idleTimeoutInMinutes,
loadDistribution,
probe,
protocol,
provisioningState,
type
FROM azure.network.load_balancer_load_balancing_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

health

Get health details of a load balancing rule.

EXEC azure.network.load_balancer_load_balancing_rules.health 
@group_name='{{ group_name }}' --required, 
@load_balancer_name='{{ load_balancer_name }}' --required, 
@load_balancing_rule_name='{{ load_balancing_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;