Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Azure Regions

The /cloudInfrastructure/regions resource collection represents Azure regions available for Veeam Backup for Microsoft Azure.

Get Collection of Azure Regions

The HTTP GET request to the /cloudInfrastructure/regions endpoint retrieves a list of Azure regions available 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
SubscriptionId
string or null <uuid>

Returns only Azure regions available in an Azure subscription with the specified ID.

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

Returns only Azure regions available to a tenant with the specified ID.

x-veeam-parameter-group: RegionOptions
ServiceAccountId
string <uuid>

Returns only Azure regions to which a service account with the specified system ID has permissions.

x-veeam-parameter-group: RegionOptions
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: RegionOptions
Sync
boolean or null

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

x-veeam-parameter-group: RegionOptions
ResourceProviderTypes
Array of strings or null (ResourceProviderType)

Returns only Azure regions that match the specified type of the resource provider.

Enum: "VirtualMachine" "SqlServer" "SqlManagedInstance" "Unknown" "VirtualNetwork" "CosmosDb" "StorageAccount"
x-veeam-parameter-group: RegionOptions
Responses
200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

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

Get Azure Region Data

The HTTP GET request to the /cloudInfrastructure/regions/{regionId} endpoint retrieves information on an Azure region with the specified ID.

SecurityBearer
Request
path Parameters
regionId
required
string or null

Specifies a Microsoft Azure ID assigned to a region.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/regions/{regionId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/regions/{regionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "resourceId": "string"
}