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.

SchemasProtectedVirtualMachineV2

Property

Type

Description

id

string

System ID assigned to the protected Azure VM 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.

azureEnvironment

array[string]

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

osType

array[string]

Type of the OS installed on the Azure VM: Windows, Linux.

regionName

string

Name of an Azure region where the Azure VM resides.

totalSizeInGB

integer($int32)

Total size of all virtual disks attached to the Azure VM.

vmSize

string

Type of the Azure VM.

hasEphemeralOsDisk

boolean

Defines whether the protected 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.

lastBackup

string($date-time)

Date and time of the last backup up 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.

protectionState

ProtectionStateV2

Status of the backup policy.

_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.

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.

SchemasProtectionStateV2

Property

Type

Description

protectionStatus

array[string]

Protection status of the Azure VM: Protected, Unprotected.

backupDestinationDetails

BackupDestinationDetailsV2

Specifies information on the backup target location.

policyName

string

Name of the backup policy.

policies

link

Request URL used to get information on the backup policy.

restorePoints

link

Request URL used to get information on restore points.

restorePointCount

integer($int32)

Number of restore points to keep in cloud-native snapshot chains.

lastBackup

string($date-time)

Date and time of the last backup session.

SchemasBackupDestinationDetailsV2

Property

Type

Description

destinations

array[string]

Specifies a type of the backup destination: Snapshot, AzureBlob, ManualSnapshot.

repositories

string

Specifies backup repositories where the protected items are stored.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.