load_balancer_outbound_rules

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

Overview

Name	load_balancer_outbound_rules
Type	Resource
Id	azure.network.load_balancer_outbound_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
allocatedOutboundPorts	integer	The number of outbound ports to be used for NAT.
backendAddressPool	object	Reference to another subresource.
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.
frontendIPConfigurations	array	The Frontend IP addresses of the load balancer. Required.
idleTimeoutInMinutes	integer	The timeout for the TCP idle connection.
protocol	string	The protocol for the outbound rule in load balancer. Required. Known values are: "Tcp", "Udp", and "All". (Tcp, Udp, All)
provisioningState	string	The provisioning state of the outbound 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.
allocatedOutboundPorts	integer	The number of outbound ports to be used for NAT.
backendAddressPool	object	Reference to another subresource.
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.
frontendIPConfigurations	array	The Frontend IP addresses of the load balancer. Required.
idleTimeoutInMinutes	integer	The timeout for the TCP idle connection.
protocol	string	The protocol for the outbound rule in load balancer. Required. Known values are: "Tcp", "Udp", and "All". (Tcp, Udp, All)
provisioningState	string	The provisioning state of the outbound 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, outbound_rule_name, subscription_id		Gets the specified load balancer outbound rule.
list	select	resource_group_name, load_balancer_name, subscription_id		Gets all the outbound rules in a load balancer.

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
load_balancer_name	string	The name of the load balancer. Required.
outbound_rule_name	string	The name of the outbound 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 outbound rule.

SELECT
id,
name,
allocatedOutboundPorts,
backendAddressPool,
enableTcpReset,
etag,
frontendIPConfigurations,
idleTimeoutInMinutes,
protocol,
provisioningState,
type
FROM azure.network.load_balancer_outbound_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND outbound_rule_name = '{{ outbound_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the outbound rules in a load balancer.

SELECT
id,
name,
allocatedOutboundPorts,
backendAddressPool,
enableTcpReset,
etag,
frontendIPConfigurations,
idleTimeoutInMinutes,
protocol,
provisioningState,
type
FROM azure.network.load_balancer_outbound_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;