Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Azure Resource Groups

The /cloudInfrastructure/resourceGroups resource collection represents resource groups configured in the Microsoft Azure environment.

Get Collection of Resource Groups

The HTTP GET request to the /cloudInfrastructure/resourceGroups endpoint retrieves a list of Azure resource groups available for Veeam Backup for Microsoft Azure.

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
SubscriptionId
string or null <uuid>

Returns only resource groups that belong to a subscription with the specified ID.

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

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

x-veeam-parameter-group: ResourceGroupOptions
ServiceAccountId
string

Returns only resource groups to which a service account with the specified system ID has permissions.

x-veeam-parameter-group: ResourceGroupOptions
RegionIds
Array of strings or null

Returns only resource groups created in Azure regions with the specified IDs.

x-veeam-parameter-group: ResourceGroupOptions
Sync
boolean or null

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

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

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

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

Get Resource Group Data

The HTTP GET request to the /cloudInfrastructure/resourceGroups/{resourceGroupId} endpoint retrieves information on an Azure resource group with the specified ID.

SecurityBearer
Request
path Parameters
resourceGroupId
required
string or null

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

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

get/api/v8/cloudInfrastructure/resourceGroups/{resourceGroupId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/resourceGroups/{resourceGroupId}?sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "resourceId": "string",
  • "name": "string",
  • "azureEnvironment": "Global",
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "tenantId": "string",
  • "regionId": "string",
  • "_links": {}
}