Get Elastic Pools

In this article

    You can get a list of all elastic pools available for Veeam Backup for Microsoft Azure.

    Request

    To retrieve a full list of available elastic pools, send the HTTP GET request to the /cloudInfrastructure/sqlElasticPool endpoint.

    HTTP Request

    GET https://<hostname>/api/v3/cloudInfrastructure/sqlElasticPool

    Query Parameters

    To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:

    Query Parameter

    Value

    Description

    Sync

    boolean

    Defines whether Veeam Backup for Microsoft Azure database is synchronized with Azure resources.

    Request Headers

    The request contains the following headers.

    Header

    Required

    Value

    Description

    Authorization

    Required

    Bearer <Access-Token>

    Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 (OK).

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTP headers.

    Header

    Value

    Description

    Content-length

    integer

    Identifies the length of the response body message, in bytes.

    Content-type

    • application/json
    • application/problem+json

    Identifies the media type of the response body message.

    Response Body

    In the response body, Veeam Backup for Microsoft Azure returns a representation of the /cloudInfrastructure/sqlElasticPool collection. The SqlElasticPoolV3 schema is used for the collection representation.

    Get Elastic PoolsExample

    The following request returns a full list of elastic pools.

    Request:

    GET https://51.11.247.127/api/v3/cloudInfrastructure/sqlEelasticPool

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200

     

    Response Body:

    {

     "offset": 0,

     "limit": 200,

     "totalCount": 6,

     "results": [

       {

         "databaseStorageCapacityMb": 5000,

         "dtu": 50,

         "edition": "Basic",

         "id": "d41h9girzxb4d6aszx7p8ehypx3dq7usjd654zuset7h4s65raco",

         "name": "bp-elastic-1",

         "regionId": "eastus",

         "resourceId": "/subscriptions/280921a2-220d-45c9-92dd-82b6d5a3a78f/resourcegroups/bp-sql/providers/microsoft.sql/servers/bp-server-eus2/elasticpools/bp-elastic-1",

         "serverId": "mtmbozrjjz7p91axo9pt9wzsii9jz3mi1m89apgnkkcswxgek6mo",

         "state": "Ready",

         "poolStorageCapacityMb": 5000,

         "subscriptionId": "280921a2-220d-45c9-92dd-82b6d5a3a78f",

         "_links": {

           "self": {

             "href": "https://51.11.247.127/api/v3/cloudInfrastructure/sqlElasticPools/d41h9girzxb4d6aszx7p8ehypx3dq7usjd411zuset7h4s65raco"

           }

         }

       },

       {

         "databaseStorageCapacityMb": 5000,

         "dtu": 50,

         "edition": "Basic",

         "id": "seygdxbrosxt4yb6hkzc5a19rr7nbeqcexwzqbo3ebg3pyrbfd8y",

         "name": "bp-elastic-2",

         "regionId": "eastus",

         "resourceId": "/subscriptions/280921a2-220d-45c9-92dd-82b6d5a3a78f/resourcegroups/bp-sql/providers/microsoft.sql/servers/bp-server-eus/elasticpools/bp-elastic-2",

         "serverId": "qhhre6nua6xdz815cwfquniemcx6zhxpd5addqndfzfpt9fztgjo",

         "state": "Ready",

         "poolStorageCapacityMb": 5000,

         "subscriptionId": "280921a2-220d-45c9-92dd-82b6d5a3a78f",

         "_links": {

           "self": {

             "href": "https://51.11.247.127/api/v3/cloudInfrastructure/sqlElasticPools/seygdxbrosxt4yb6hkzc5a19rr7nbeqcexwzqbo3ebg3pyrbfd8y"

           }

         }

       },

      }

     ],

     "_links": {

       "self": {

         "href": "https://51.11.247.127/api/v3/cloudInfrastructure/sqlElasticPools?offset=0&limit=200"

       }

     }

    }