Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Azure Subscriptions

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

Get Collection of Microsoft Azure Subscriptions

The HTTP GET request to the /cloudInfrastructure/subscriptions endpoint retrieves a list of Microsoft Azure subscriptions available to the service accounts added to Veeam Backup for Microsoft Azure configuration.

SecurityBearer
Request
query Parameters
AccountId
string or null

Returns only subscriptions to which the service account with the specified ID has permissions.

x-veeam-parameter-group: SubscriptionOptions
TenantId
string or null <uuid>

Returns only subscriptions that belong to a tenant with the specified ID.

x-veeam-parameter-group: SubscriptionOptions
SearchPattern
string or null

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

x-veeam-parameter-group: SubscriptionOptions
OnlyIds
Array of strings or null

Returns only subscriptions with the specified IDs.

x-veeam-parameter-group: SubscriptionOptions
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
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/subscriptions
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/subscriptions?AccountId=string&TenantId=497f6eca-6276-4993-bfeb-53cbbbba6f08&SearchPattern=string&OnlyIds=string&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Get Microsoft Azure Subscription Data

The HTTP GET request to the /cloudInfrastructure/subscriptions/{subscriptionId} endpoint retrieves information on a subscription with the specified ID.

SecurityBearer
Request
path Parameters
subscriptionId
required
string <uuid>

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

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/subscriptions/{subscriptionId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/subscriptions/{subscriptionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "environment": "Global",
  • "tenantId": "string",
  • "tenantName": "string",
  • "name": "string",
  • "status": "Active",
  • "availability": "Available",
  • "workerResourceGroupName": "string",
  • "_links": {}
}