Load Balancers - Get

Service:: Load balancer

API Version:: 2017-09-01

Gets the specified load balancer.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}?api-version={api-version}

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}?api-version={api-version}&$expand={$expand}

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
resourceGroupName	path	True	string	The name of the resource group.
loadBalancerName	path	True	string	The name of the load balancer.
$expand	query		string	Expands referenced resources.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	LoadBalancer	Request successful. The operation returns the resulting LoadBalancer resource. Media Types: "application/json", "text/json"

Name

Type

Description

200 OK

LoadBalancer

Request successful. The operation returns the resulting LoadBalancer resource.

Media Types: "application/json", "text/json"

Examples

Get load balancer

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb?api-version=2017-09-01

Sample Response

Status code:: 200

{
  "name": "lb",
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb",
  "type": "Microsoft.Network/loadBalancers",
  "location": "westus",
  "sku": {
    "name": "Basic"
  },
  "properties": {
        "provisioningState": "Succeeded",
        "frontendIPConfigurations": [
      {
        "name": "fe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb",
        "properties": {
          "provisioningState": "Succeeded",
          "privateIPAddress": "10.0.1.4",
          "privateIPAllocationMethod": "Dynamic",
          "subnet": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb"
          },
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ],
          "inboundNatRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule"
            }
          ]
        }
      }
    ],
        "backendAddressPools": [
      {
        "name": "be-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb",
        "properties": {
          "provisioningState": "Succeeded",
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
        "loadBalancingRules": [
      {
        "name": "rulelb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 80,
          "backendPort": 80,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp",
          "loadDistribution": "Default",
          "backendAddressPool": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb"
          },
          "probe": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb"
          },
          "disableOutboundSnat": false
        }
      }
    ],
        "probes": [
      {
        "name": "probe-lb",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb",
        "properties": {
          "provisioningState": "Succeeded",
          "protocol": "Http",
          "port": 80,
          "requestPath": "healthcheck.aspx",
          "intervalInSeconds": 15,
          "numberOfProbes": 2,
          "loadBalancingRules": [
            {
              "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb"
            }
          ]
        }
      }
    ],
        "inboundNatRules": [
      {
        "name": "in-nat-rule",
        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule",
        "properties": {
          "provisioningState": "Succeeded",
          "frontendIPConfiguration": {
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb"
          },
          "frontendPort": 3389,
          "backendPort": 3389,
          "enableFloatingIP": true,
          "idleTimeoutInMinutes": 15,
          "protocol": "Tcp"
        }
      }
    ],
        "outboundNatRules": [],
        "inboundNatPools": []
  }
}

Definitions

BackendAddressPool	Pool of backend IP addresses.
FrontendIPConfiguration	Frontend IP address of the load balancer.
InboundNatPool	Inbound NAT pool of the load balancer.
InboundNatRule	Inbound NAT rule of the load balancer.
LoadBalancer
LoadBalancerSku	The load balancer SKU.
LoadBalancingRule	A load balancing rule for a load balancer.
OutboundNatRule	Outbound NAT pool of the load balancer.
Probe	A load balancer probe.
SubResource	Reference to another subresource.

BackendAddressPool

Pool of backend IP addresses.

Name	Type	Description
backendIPConfigurations	SubResource[]	Gets collection of references to IP addresses defined in network interfaces.
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID
loadBalancingRules	SubResource[]	Gets load balancing rules that use this backend address pool.
name	string	Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
outboundNatRule	SubResource	Gets outbound rules that use this backend address pool.
provisioningState	string	Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

FrontendIPConfiguration

Frontend IP address of the load balancer.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID
inboundNatPools	SubResource[]	Read only. Inbound pools URIs that use this frontend IP.
inboundNatRules	SubResource[]	Read only. Inbound rules URIs that use this frontend IP.
loadBalancingRules	SubResource[]	Gets load balancing rules URIs that use this frontend IP.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
outboundNatRules	SubResource[]	Read only. Outbound rules URIs that use this frontend IP.
privateIPAddress	string	The private IP address of the IP configuration.
privateIPAllocationMethod	enum: Static Dynamic	The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.
provisioningState	string	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
publicIPAddress	SubResource	The reference of the Public IP resource.
subnet	SubResource	The reference of the subnet resource.
zones	string[]	A list of availability zones denoting the IP allocated for the resource needs to come from.

InboundNatPool

Inbound NAT pool of the load balancer.

Name	Type	Description
backendPort	integer int32	The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.
etag	string	A unique read-only string that changes whenever the resource is updated.
frontendIPConfiguration	SubResource	A reference to frontend IP addresses.
frontendPortRangeEnd	integer int32	The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535.
frontendPortRangeStart	integer int32	The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534.
id	string	Resource ID
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
protocol	enum: Udp Tcp All	The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.'
provisioningState	string	Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

InboundNatRule

Inbound NAT rule of the load balancer.

Name	Type	Description
backendIPConfiguration	SubResource	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.
backendPort	integer int32	The port used for the internal endpoint. Acceptable values range from 1 to 65535.
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.
etag	string	A unique read-only string that changes whenever the resource is updated.
frontendIPConfiguration	SubResource	A reference to frontend IP addresses.
frontendPort	integer int32	The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534.
id	string	Resource ID
idleTimeoutInMinutes	integer int32	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.
name	string	Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
protocol	enum: Udp Tcp All	The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.'
provisioningState	string	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

LoadBalancer

Name	Type	Description
backendAddressPools	BackendAddressPool[]	Collection of backend address pools used by a load balancer
etag	string	A unique read-only string that changes whenever the resource is updated.
frontendIPConfigurations	FrontendIPConfiguration[]	Object representing the frontend IPs to be used for the load balancer
id	string	Resource ID.
inboundNatPools	InboundNatPool[]	Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules.
inboundNatRules	InboundNatRule[]	Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules.
loadBalancingRules	LoadBalancingRule[]	Object collection representing the load balancing rules Gets the provisioning
location	string	Resource location.
name	string	Resource name.
outboundNatRules	OutboundNatRule[]	The outbound NAT rules.
probes	Probe[]	Collection of probe objects used in the load balancer
provisioningState	string	Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
resourceGuid	string	The resource GUID property of the load balancer resource.
sku	LoadBalancerSku	The load balancer SKU.
tags	<string, string>	Resource tags.
type	string	Resource type.

LoadBalancerSku

The load balancer SKU.

Name	Type	Description
name	enum: Basic Standard	Name of a load balancer SKU.

LoadBalancingRule

A load balancing rule for a load balancer.

Name	Type	Description
backendAddressPool	SubResource	A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs.
backendPort	integer int32	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.
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.
etag	string	A unique read-only string that changes whenever the resource is updated.
frontendIPConfiguration	SubResource	A reference to frontend IP addresses.
frontendPort	integer int32	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"
id	string	Resource ID
idleTimeoutInMinutes	integer int32	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	enum: Default SourceIP SourceIPProtocol	The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
probe	SubResource	The reference of the load balancer probe used by the load balancing rule.
protocol	enum: Udp Tcp All	The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All.'
provisioningState	string	Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

OutboundNatRule

Outbound NAT pool of the load balancer.

Name	Type	Description
allocatedOutboundPorts	integer int32	The number of outbound ports to be used for NAT.
backendAddressPool	SubResource	A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs.
etag	string	A unique read-only string that changes whenever the resource is updated.
frontendIPConfigurations	SubResource[]	The Frontend IP addresses of the load balancer.
id	string	Resource ID
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
provisioningState	string	Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.

Probe

A load balancer probe.

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Resource ID
intervalInSeconds	integer int32	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	SubResource[]	The load balancer rules that use this probe.
name	string	Gets name of the resource that is unique within a resource group. This name can be used to access the resource.
numberOfProbes	integer int32	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 int32	The port for communicating the probe. Possible values range from 1 to 65535, inclusive.
protocol	enum: Http Tcp	The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.
provisioningState	string	Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'.
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.

SubResource

Reference to another subresource.

Name	Type	Description
id	string	Resource ID.