This is an archive version of the document. To get the most up-to-date information, see the current version.

Schemas

The following JSON schema is used to represent resources in the /protectedItem collection in the Veeam Backup for Microsoft Azure REST API. Properties included in schemas represent Azure VM details. Some of the properties can be used in POST and PUT requests as well as for query parameter values in GET requests.

SchemasProtectedDatabaseV3

Property

Type

Description

id

string

System ID assigned to the protected Azure SQL databse in the Veeam Backup for Microsoft Azure REST API.

azureId

string

Azure ID assigned to the protected Azure VM.

name

string

Name of the Azure VM.

sqlServer

SqlServerForProtectedDatabaseV3

Information on an SQL Server where the protected database is located.

azureEnvironment

array[string]

Type of the Microsoft Azure environment: Global, Germany, China, USGovernment.

sizeInMb

integer(64)

Total size of the compressed backup files of the Azure SQL database.

subscriptionId

string

Azure ID assigned to an Azure subscription.

sqlElasticPool

string

Azure ID of the elastic pool to which the database is included.

lastBackup

string($date-time)

Date and time of the last backup session.

subscription

AzureSubscriptionV2

Information on an Azure subscription.

region

RegionV2

Information on an Azure region where a virtual disk resides.

resourceGroup

ResourceGroupV2

Information on a resource group where the virtual disk belongs.

_links

string

A list of methods and operations available for the disk snapshots in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations.

SchemasSqlServerForProtectedDatabaseV3

Property

Type

Description

id

string

Azure ID assigned to the SQL Server hosting the protected databse.

name

string

Name of the SQL Server.

serverType

string

Type of the SQL Server: Managed, Unmanaged.

SchemasAzureSubscriptionV2

Property

Type

Description

id

string

Azure ID assigned to the Azure subscription.

environment

array[string]

Type of the Microsoft Azure environment: Global, Germany, China, USGovernment.

tenantId

string

Azure ID assigned to the tenant associated with the subscription.

tenantName

string

Name of the tenant.

name

string

Name of the Azure subscription

status

array[string]

Status of the Azure subscription: Active, Disabled.

_links

string

A list of methods and operations available for the Azure subscription in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations.

SchemasRegionV2

Property

Type

Description

id

string

System ID in Veeam Backup for Microsoft Azure assigned to the Azure region where a virtual disk resides.

name

string

Name of the Azure region.

SchemasResourceGroupV2

Property

Type

Description

id

string

Azure ID assigned to the resource group.

environment

array[string]

The type of the Microsoft Azure environment: Global, Germany, China, USGovernment.

tenantId

string

Azure ID assigned to the tenant associated with the resource group.

tenantName

string

Name of the tenant.

name

string

Name of the Azure subscription.

status

array[string]

Status of the Azure subscription: Active, Disabled.

_links

string

A list of methods and operations available for the Azure subscription in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations.