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 /virtualMachines 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.

VirtualMachinev3

Property	Type	Description
id	string	System ID assigned to the Azure VM in Veeam Backup for Microsoft Azure REST API.
azureId	string	Azure ID assigned to the Azure VM.
name	string	Name of the Azure VM.
azureEnvironment	string	Type of an Azure environment: Global, Germany, China, USGovernment.
osType	array[string]	Type of an operation system installed on the Azure VM: Windows, Linux.
regionName	string	Name of the Azure region where the Azure VM resides.
totalSizeInGB	integer($int32)	Total size of all virtual disks attached to the Azure VM.
vmSize	string	Size of the Azure VM.
dnsName	string	DNS hostname of the Azure VM.
virtualNetwork	string	Azure ID assigned to a virtual network connected to the backup appliance.
subnet	string	Name of a subnet connected to the backup appliance.
publicIP	string	Public IP address associated with the backup appliance.
privateIP	string	Public IP address associated with the backup appliance.
hasEphemeralOsDisk	boolean	Defines whether the Azure VM has an ephemeral OS disk attached.
availabilityZone	string	Specifies the Availability Zone where the Azure VM belongs.
isController	boolean	Defines whether Veeam Backup for Microsoft Azure is installed on the Azure VM.
isDeleted	boolean	Defines whether an Azure VM is no longer present in the Azure infrastructure.
_links	array	A list of methods and operations available for the Azure VM in the Veeam Backup for Microsoft Azure REST API, and request URLs used to perform the operations.