Veeam Backup for Microsoft Azure 8 [Archived]
REST API Reference
Related documents

Microsoft Entra Tenants

The /cloudInfrastructure/tenants resource collection represents tenants available to service accounts added to the Veeam Backup for Microsoft Azure configuration database.

Get Collection of Tenants

The HTTP GET request to the /cloudInfrastructure/tenants endpoint retrieves a list of tenants in which Azure resources protected by Veeam backup for Microsoft Azure reside.

SecurityBearer
Request
query Parameters
SearchPattern
string or null

Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.

Offset
integer <int32> >= 0

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

Limit
integer <int32> >= -1

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

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/tenants
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "Canceled",
  • "error": {
    },
  • "_links": {},
  • "result": {}
}
Get Tenants by Service Account
The HTTP GET request to the /cloudInfrastructure/tenants/withAccount endpoint retrieves tenants with information on service accounts linked to these tenants.


SecurityBearer 
Request 
query Parameters
SearchPattern
string or null
Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.


 
Sync
boolean or null
Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.


 
Offset
integer <int32>   >= 0 
Specifies the first N items of a resource collection that will be excluded from the response.


 
Limit
integer <int32>   >= -1 
Specifies the maximum number of items of a resource collection that will be returned in the response.


 
Responses 
200
OK


202
Accepted


400
Bad Request


401
Unauthorized


403
Forbidden


get/api/v8/cloudInfrastructure/tenants/withAccount
Request samples 
Response samples 
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}
Get Tenant Data
The HTTP GET request to the /cloudInfrastructure/tenants/{tenantId} endpoint retrieves information on a tenant with the specified ID.


SecurityBearer 
Request 
path Parameters
tenantId
required
string <uuid> 
Microsoft Entra tenant ID.


 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/v8/cloudInfrastructure/tenants/{tenantId}
Request samples 
Response samples 
application/json
{}