Load Balancers - List

Reference

Service:: Azure Stack Admin

API Version:: 2015-06-15

Get a list of all load balancers.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network.Admin/adminLoadBalancers?api-version=2015-06-15

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network.Admin/adminLoadBalancers?api-version=2015-06-15&$filter={$filter}&$orderBy={$orderBy}&$top={$top}&$skip={$skip}&$inlineCount={$inlineCount}

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API Version.
$filter	query		string	OData filter parameter.
$inlineCount	query		string	OData inline count parameter.
$orderBy	query		string	OData orderBy parameter.
$skip	query		string	OData skip parameter.
$top	query		string	OData top parameter.

Responses

Name	Type	Description
200 OK	LoadBalancerList	OK

Security

azure_auth

Azure Active Directory OAuth2 flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List all load balancers

Sample Request

HTTP

GET https://management.azure.com/subscriptions/fc8456aa-4843-4079-a152-f3497c63aa73/providers/Microsoft.Network.Admin/adminLoadBalancers?api-version=2015-06-15

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "TestLoadBalancer",
      "type": "Microsoft.Network.Admin/adminLoadBalancers",
      "location": "",
      "id": "/subscriptions/fc8456aa-4843-4079-a152-f3497c63aa73/providers/Microsoft.Network.Admin/adminLoadBalancers/TestLoadBalancer",
      "properties": {
        "provisioningState": "Succeeded",
        "publicIpAddresses": [
          "192.168.102.32"
        ],
        "subscriptionId": "fc8456aa-4843-4079-a152-f3497c63aa73",
        "tenantResourceUri": "/subscriptions/fc8456aa-4843-4079-a152-f3497c63aa73/resourceGroups/GreatResource/providers/Microsoft.Network/loadBalancers/TestLoadBalancer"
      }
    }
  ]
}

Definitions

Name	Description
LoadBalancer	Representation of a load balancer.
LoadBalancerList	Pageable list of load balancers.

LoadBalancer

Representation of a load balancer.

Name	Type	Description
id	string	URI of the resource.
location	string	Region location of resource.
name	string	Name of the resource.
properties.provisioningState	string	The provisioning state.
properties.publicIpAddresses	string[]	List of public IP addresses.
properties.subscriptionId	string	The subscription ID.
properties.tenantResourceUri	string	The tenant resource URI.
tags	object	List of key value pairs.
type	string	Type of resource.

LoadBalancerList

Pageable list of load balancers.

Name	Type	Description
nextLink	string	URI to the next page.
value	LoadBalancer[]	List of load balancers for this page.

Share via