Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Azure SQL Elastic Pools

The /cloudInfrastructure/sqlElasticPools resource collection represents elastic pools added to the Microsoft Azure environment.

Get Collection of Elastic Pools

The HTTP GET request to the /cloudInfrastructure/sqlElasticPools endpoint retrieves a list of SQL elastic pools configured in the Microsoft Azure environment.

SecurityBearer
Request
query Parameters
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

x-veeam-parameter-group: SqlElasticPoolOptions
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/sqlElasticPools
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/sqlElasticPools?Offset=0&Limit=-1&Sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Elastic Pool Data

The HTTP GET request to the /cloudInfrastructure/sqlElasticPools/{sqlElasticPoolId} endpoint retrieves information on a SQL elastic pool with the specified ID.

SecurityBearer
Request
path Parameters
sqlElasticPoolId
required
string or null

Specifies a system ID assigned in the Veeam Backup for Microsoft Azure REST API to a SQL elastic pool.

query Parameters
sync
boolean or null

Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/sqlElasticPools/{sqlElasticPoolId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/sqlElasticPools/{sqlElasticPoolId}?sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "databaseStorageCapacityMb": 0,
  • "dtu": 0,
  • "edition": "string",
  • "id": "string",
  • "name": "string",
  • "regionId": "string",
  • "resourceId": "string",
  • "serverId": "string",
  • "state": "string",
  • "poolStorageCapacityMb": 0,
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "_links": {}
}