Microsoft Azure Load Balancer

Please refer to the Microsoft Azure Sources topic for additional information on how to configure the LPU, and general Azure Data Collection setup details.

Load Balancer Types: Standard vs Basic

As a feature with Standard Load Balancers, Microsoft makes performance metrics available within the the API. The metrics listed below are only available at the Standard license level.

The Source will configure and collect property metrics with the Basic Load Balancer type.

Least Privileged User

Steps:

Using the Azure CLI Client, find the Subscription ID and Tenant ID from your account list
Create a custom RBAC role using the JSON provided. Include your Subscription ID and rename the file to azure.json
Create an Active Directory Service Principal and assign the custom RBAC role t it.

Creating custom roles using the Azure CLI:

https://docs.microsoft.com/en-us/azure/role-based-access-control/custom-roles

Assigning roles using the Azure CLI:

https://docs.microsoft.com/en-us/azure/role-based-access-control/role-assignments-portal

{
  "Name": "LPU Load Balancers",
  "Description": "LPU for Load Balancers",
  "Actions": [
    "Microsoft.Network/loadBalancers/*/read",
    "Microsoft.Network/publicIPAddresses/*/read",
    "Microsoft.Network/networkInterfaces/*/read",
    "Microsoft.Authorization/*/read",
    "Microsoft.Insights/metrics/*/read"
  ],
  "AssignableScopes": [
    "/subscriptions/[Subscription ID]"
  ]
}

Connection Parameters

Name	Required?	Description
Subscription ID	Required	GUID Subscription ID
Tenant ID	Required	GUID Tenant ID (also known as Directory ID)
Client ID	Required	GUID Client ID (also known as Application ID)
Client Secret	Required	The Secret (also known as Key) corresponding to the Client ID.
Maximum HTTP Retry Time (seconds)		The maximum amount of time in seconds to retry each API request when the API is throttling.
HTTP Request Timeout (seconds)		The maximum amount of time in seconds before a single HTTP request will fail.
Monitor Metric Collection Level		Selects which monitor metrics should be collected.
Filter By Resource Group Type		Selects whether to use a whitelist or blacklist when filtering by Resource Groups.
Filter By Resource Group Whitelist		A comma separated list of resource groups to explicitly allow. A '*' character is used to represent 'all', and a blank string is used for 'none'.
Filter By Resource Group Blacklist		A comma separated list of resource groups to filter out. A '*' character is used to represent 'all', and a blank string is used for 'none'.
Filter By Tags Group Type		Selects whether to use a whitelist or blacklist when filtering by Resource Groups.
Filter By Tags Group Whitelist		A comma separated list of tags to explicitly allow. Tags must follow the format <key:value>. Instead of a specific tag, or tag value, a '*' character is used to represent 'all'. A blank entry is treated as 'none'.
Filter By Tags Group Blacklist		A comma separated list of tags to filter out. Tags must follow the format <key:value>. Instead of a specific tag, or tag value, a '*' character is used to represent 'all'. A blank entry is treated as 'none'.

Metrics

🚧
Standard Load Balancer Only for Complete Metrics
A Standard type Load Balancer is required for availability of the below metrics. For more information see: Load Balancer Types: Standard vs Basic

API Usage

Name	Description
Average Pages	The average amount of pages needed for a paged resource type.
Average Request Retries	The average number of retry requests per unique requests made.
Average Retry Attempts	The average number of retry requests made per unique request that was retried.
Average Retry Wait (Milliseconds)	The average amount of time retried requests spent waiting.
Client ID	The client ID used to make API calls.
Failed Requests	The total number of requests that returned a failure response.
Maximum Pages	The most amount of pages needed for a paged resource type.
Maximum Retries	The highest number of retries made for a single request.
Maximum Retry Wait (Milliseconds)	The most amount of time a retried request spent waiting.
Minimum Pages	The least amount of pages needed for a paged resource type.
Minimum Retry Wait (Milliseconds)	The least amount of time a retried request spent waiting.
Other Status Responses	The total number of successful requests that responded with some other accepted status.
Request Timeouts	The total number of requests that timed out waiting for a response.
Requests Retried	The number of unique requests that were retried.
Retry Status Responses	The total number of successful requests that responded with the status TOO MANY REQUESTS (429).
Retry Timeouts	The total number of requests that needed to be retried, but the request retry time exceeded the maximum retry time.
Status OK Responses	The total number of successful requests that responded with the status OK (200).
Subscription ID	The subscription ID used to make API calls.
Successful Requests	The total number of requests that returned a successful response.
Tenant ID	The tenant ID used to make API calls.
Total Monitor Requests	The total number of requests made to get monitor metrics.
Total Paged Requests	The total amount of resource types that required paging.
Total Requests	The total number of requests made during collection.
Total Retries	The total number of retry requests that were made.
Unique Monitor Requests	The number of unique requests made to get monitor metrics.
Unique Requests	The number of requests made with unique endpoints.

Backend Address Pool

Name	Description
Backend IP Configurations	The IDs of the backend IP configurations associated with the backend address pool
Entity Tag	A unique read-only string that changes whenever the resource is updated
ID	Resource ID of the address pool
Load Balancing Rules	The IDs of the load balancing rules associated with the backend address pool
Name	Resource name of the address pool
Provisioning State	Provisioning state of the public IP resource

Backend Endpoint

Name	Description
Dynamic IP Address	Dynamic IP Address
Dynamic IP Availability	Availability of DIP endpoints, based on probe results
Dynamic IP Port	Dynamic IP Port
Parent ID	Parent ID

Backend IP Configuration

Name	Description
Entity tag	A unique read-only string that changes whenever the resource is updated
ID	Resource ID of the IP configuration
Is In Use With Service	Whether or the the IP configuration is in use with a service
Load Balancer Backend Address Pools	A list of the load balancer backend address pool IDs associated with the IP configuration
Name	Resource name of the backend IP configuration
Primary	Gets whether this is a primary customer address on the network interface
Private IP Address	Private IP address of the IP configuration
Private IP Address Version	Represents whether the specific IP configuration is IPv4 or IPv6
Private IP Allocation Method	Defines how a private IP address is assigned
Provisioning State	The provisioning state of the network interface IP configuration
Subnet	Resource ID of the associated subnet

Frontend Application

Name	Description
Data Throughput In (Bytes)	Total incoming throughput transmitted within time period
Data Throughput Out (Bytes)	Total outgoing throughput transmitted within time period
Dynamic IP Availability	Availability of DIP endpoints, based on probe results
Packets Routed In (Packets)	Total incoming Packets transmitted within time period
Packets Routed Out (Packets)	Total outgoing Packets transmitted within time period
Parent ID	Parent ID
SYN Count	Total number of SYN Packets transmitted within time period
Total Data Throughput (Bytes)	Total throughput transmitted within time period
Total Packets Routed (Packets)	Total number of Packets transmitted within time period
Virtual IP Address	Virtual IP Address
Virtual IP Availability	Availability of VIP endpoints, based on probe results
Virtual IP Port	Virtual IP Port

Frontend IP Configuration

Name	Description
Entity Tag	A unique read-only string that changes whenever the resource is updated
ID	Resource ID of the IP configuration
Name	Resource name of the IP configuration
Private IP Allocation Method	The Private IP allocation method
Provisioning State	Gets the provisioning state of the public IP resource
Public IP Address	The public IP address of the frontend IP configuration
Public IP Address ID	The public IP address ID of the frontend IP configuration
Subnet	The reference of the subnet resource

Frontend Server

Name	Description
Data Throughput In (Bytes)	Total incoming throughput transmitted within time period
Data Throughput Out (Bytes)	Total outgoing throughput transmitted within time period
Dynamic IP Availability	Availability of DIP endpoints, based on probe results
Packets Routed In (Packets)	Total incoming Packets transmitted within time period
Packets Routed Out (Packets)	Total outgoing Packets transmitted within time period
Parent ID	Parent ID
SNAT Connection Count	Total number of new SNAT connections created within time period
SYN Count	Total number of SYN Packets transmitted within time period
Total Data Throughput (Bytes)	Total throughput transmitted within time period
Total Packets Routed (Packets)	Total number of Packets transmitted within time period
Virtual IP Address	Virtual IP Address
Virtual IP Availability	Availability of VIP endpoints, based on probe results

Inbound NAT Rule

Name	Description
Backend IP Configuration	A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP
Backend Port	The port used for the internal endpoint
Enable Floating IP	Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group
Frontend IP Configuration	A reference to frontend IP addresses
Frontend Port	The port for the external endpoint
ID	Resource ID of the NAT rule
Idle Timeout (Minutes)	The timeout for the TCP idle connection
Name	Resource name of the NAT rule
Protocol	The transport protocol for the endpoint
Provisioning State	The provisioning state of the public IP resource

Load Balancer

Name	Description
Data Throughput In (Bytes)	Total incoming throughput transmitted within time period
Data Throughput Out (Bytes)	Total outgoing throughput transmitted within time period
Dynamic IP Availability	Availability of DIP endpoints, based on probe results
Entity Tag	A unique read-only string that changes whenever the resource is updated
ID	The ID of the load balancer
Location	The location of the load balancer
Name	The load balancer's name
Packets Routed In (Packets)	Total incoming Packets transmitted within time period
Packets Routed Out (Packets)	Total outgoing Packets transmitted within time period
Provisioning State	Gets the provisioning state of the public IP resource
Resource Group	The Resource Group of the Azure resource.
Resource GUID	The GUID of the load balancer
SKU Name	The name of the SKU associated with the load balancer
SKU Tier	The tier of the SKU associated with the load balancer
SNAT Connection Count	Total number of new SNAT connections created within time period
SYN Count	Total number of SYN Packets transmitted within time period
Tags	Microsoft Azure resource tags
Total Data Throughput (Bytes)	Total throughput transmitted within time period
Total Packets Routed (Packets)	Total number of Packets transmitted within time period
Type	Microsoft Azure resource type
Virtual IP Availability	Availability of VIP endpoints, based on probe results

Load Balancing Rule

Name	Description
Backend Address Pool	A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs
Backend Port	The port used for internal connections on the endpoint
Enable Floating IP	Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group
Entity Tag	A unique read-only string that changes whenever the resource is updated
Frontend IP Configuration	A reference to frontend IP addresses
Frontend Port	The port for the external endpoint
ID	Resource ID of the rule
Idle Timeout (Minutes)	The timeout for the TCP idle connection
Load Distribution	The load distribution policy for this rule
Name	Resource name of the rule
Probe	The reference of the load balancer probe used by the load balancing rule
Protocol	The transport protocol for the endpoint
Provisioning State	The provisioning state of the PublicIP resource

Network Interface

Name	Description
Dynamic IP Availability	Availability of DIP endpoints, based on probe results
Enable Accelerated Networking	If the network interface is accelerated networking enabled
Enable IP Forwarding	Indicates whether IP forwarding is enabled on this network interface
Entity Tag	A unique read-only string that changes whenever the resource is updated
ID	Resource ID of the network interface
Location	The location of the network interface
MAC Address	The MAC address of the network interface
Name	Resource name of the network interface
Network Security Group	The reference of the NetworkSecurityGroup resource
Primary	Gets whether this is a primary network interface on a virtual machine
Private IP Address	The private IP address of the associated IP configuration
Provisioning State	The provisioning state of the public IP resource
Resource GUID	The resource GUID property of the network interface resource
SNAT Connection Count	Total number of new SNAT connections created within time period
Tags	Microsoft Azure resource tags
Type	Microsoft Azure resource type
Virtual Machine	The reference of a virtual machine
Virtual Network Tap Provisioning State	The provisioning state of the virtual network tap

Probe

Name	Description
Entity Tag	A unique read-only string that changes whenever the resource is updated
ID	Resource ID of the probe
Interval (Seconds)	The interval for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period which allows two full probes before taking the instance out of rotation
Name	Resource name of the probe
Number Of Probes	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	The port for communicating the probe
Protocol	The protocol of the end point
Provisioning State	The provisioning state of the public IP resource
Request Path	The URI used for requesting health status from the VM

Public IP Address

Name	Description
Allocation Method	The public IP allocation method
Entity Tag	A unique read-only string that changes whenever the resource is updated
ID	Resource ID of the public IP address
Idle Timeout (Minutes)	The idle timeout of the public IP address
IP Address	The IP address associated with the public IP address resource
IP Configuration	The IP configuration associated with the public IP address
Location	Resource location of the public IP address
Name	Resource name of the public IP Address
Provisioning State	The provisioning state of the PublicIP resource
Resource GUID	The resource GUID property of the public IP resource
SKU Name	Name of a public IP address SKU
SKU Tier	Tier of a public IP address SKU
Tags	Microsoft Azure resource tags
Type	Microsoft Azure resource type
Version	The public IP address version

Bindplane

The Bindplane Developer Hub

Search results for "{{ search.query }}"

Microsoft Azure Load Balancer

Load Balancer Types: Standard vs Basic

Least Privileged User

Steps:

Creating custom roles using the Azure CLI:

Assigning roles using the Azure CLI:

Connection Parameters

Metrics

🚧
Standard Load Balancer Only for Complete Metrics

API Usage

Backend Address Pool

Backend Endpoint

Backend IP Configuration

Frontend Application

Frontend IP Configuration

Frontend Server

Inbound NAT Rule

Load Balancer

Load Balancing Rule

Network Interface

Probe

Public IP Address

Microsoft Azure Load Balancer

Suggested Edits are limited on API Reference Pages

Load Balancer Types: Standard vs Basic

Least Privileged User

Steps:

Creating custom roles using the Azure CLI:

Assigning roles using the Azure CLI:

Connection Parameters

Metrics

🚧Standard Load Balancer Only for Complete Metrics

API Usage

Backend Address Pool

Backend Endpoint

Backend IP Configuration

Frontend Application

Frontend IP Configuration

Frontend Server

Inbound NAT Rule

Load Balancer

Load Balancing Rule

Network Interface

Probe

Public IP Address

🚧
Standard Load Balancer Only for Complete Metrics