load_balancer_probes

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

Overview

Name	load_balancer_probes
Type	Resource
Id	azure.network.load_balancer_probes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
intervalInSeconds	integer	The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.
loadBalancingRules	array	The load balancer rules that use this probe.
noHealthyBackendsBehavior	string	Determines how new connections are handled by the load balancer when all backend instances are probed down. Known values are: "AllProbedDown" and "AllProbedUp". (AllProbedDown, AllProbedUp)
numberOfProbes	integer	The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.
port	integer	The port for communicating the probe. Possible values range from 1 to 65535, inclusive. Required.
probeThreshold	integer	The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation.
protocol	string	The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. Required. Known values are: "Http", "Tcp", and "Https". (Http, Tcp, Https)
provisioningState	string	The provisioning state of the probe resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
requestPath	string	The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
intervalInSeconds	integer	The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5.
loadBalancingRules	array	The load balancer rules that use this probe.
noHealthyBackendsBehavior	string	Determines how new connections are handled by the load balancer when all backend instances are probed down. Known values are: "AllProbedDown" and "AllProbedUp". (AllProbedDown, AllProbedUp)
numberOfProbes	integer	The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure.
port	integer	The port for communicating the probe. Possible values range from 1 to 65535, inclusive. Required.
probeThreshold	integer	The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation.
protocol	string	The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. Required. Known values are: "Http", "Tcp", and "Https". (Http, Tcp, Https)
provisioningState	string	The provisioning state of the probe resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
requestPath	string	The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value.
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, probe_name, subscription_id		Gets load balancer probe.
list	select	resource_group_name, load_balancer_name, subscription_id		Gets all the load balancer probes.

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.
probe_name	string	The name of the probe. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets load balancer probe.

SELECT
id,
name,
etag,
intervalInSeconds,
loadBalancingRules,
noHealthyBackendsBehavior,
numberOfProbes,
port,
probeThreshold,
protocol,
provisioningState,
requestPath,
type
FROM azure.network.load_balancer_probes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND probe_name = '{{ probe_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the load balancer probes.

SELECT
id,
name,
etag,
intervalInSeconds,
loadBalancingRules,
noHealthyBackendsBehavior,
numberOfProbes,
port,
probeThreshold,
protocol,
provisioningState,
requestPath,
type
FROM azure.network.load_balancer_probes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND load_balancer_name = '{{ load_balancer_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;