Schemas

The following JSON schemas are used to represent resources in the /virtualMachineSnapshots collection in the Veeam Backup for Microsoft Azure REST API. Properties included in schemas represent information on virtual disk snapshots.

SchemasVmSnapshotV2

Property

Type

Description

vmId

string

System ID assigned to an Azure VM in Veeam Backup for Microsoft Azure.

vmAzureResourceId

string

Azure ID assigned to the Azure VM.

name

string

Name of the Azure VM.

subscription

AzureSubscriptionV2

Information on Microsoft Azure subscription.

resourceGroup

ResourceGroupV2

Resource group where the Azure VM belongs.

region

RegionV2

Information on a region where the Azure VM resides.

size

string

Size of the Azure VM.

hasEphemeralOsDisk

boolean

Defines whether the protected Azure VM has an ephemeral OS disk attached.

osDisk

VmDiskSnapshotV2

Information on OS disk attached to the Azure VM.

dataDisks

VmDiskSnapshotV2

Information on virtual disks attached to the Azure VM.

virtualNetwork

VirtualNetworkV2

Specifies settings of the virtual network connected to the backup appliance.

subnet

VirtualNetworkSubnetBaseV2

Specifies settings of the subnet connected to the backup appliance.

networkSecurityGroup

NetworkSecurityGroupV2

Specifies network security group settings.

availabilitySet

AvailabilitySetV2

Specifies availability set settings.

availabilityZone

string

Specifies an Availability Zone where the Azure VM belongs.

_links

string

A list of methods and operations available for the Azure VM 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 an Azure subscription.

environment

array[string]

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

tenantId

string

Azure ID of a tenant to which the backup appliance belongs.

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

Azure ID assigned to an Azure region where the Azure VM resides.

name

string

Name of the Azure region where the Azure VM resides.

SchemasResourceGroupV2

Property

Type

Description

id

string

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

resourceId

string

Azure ID assigned to a resource group.

name

string

Name of a resource group.

azureEnvironment

array[string]

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

subscriptionId

string($uuid)

Azure ID assigned to a subscription in the Veeam Backup for Microsoft Azure REST API where the resource group belongs.

regionId

string

Name of the Azure region where a resource group resides.

_links

array

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

SchemasVmDiskSnapshotV2

Property

Type

Description

diskId

string

Azure ID assigned to a virtual disk.

name

string

Name of the virtual disk.

SchemasVirtualNetworkV2

Property

Type

Description

id

string

Azure ID of the virtual network.

name

string

Name of the virtual network.

regionName

string

Name of the Azure region where the virtual network is located.

addressSpaces

string

IP address range of the created virtual network.

_links

array

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

SchemasVirtualNetworkSubnetBaseV2

Property

Type

Description

name

string

Name of a subnet.

addressSpaces

string

IP address range of the subnet.

SchemasNetworkSecurityGroupV2

Property

Type

Description

id

string

Azure ID assigned to a network security group.

name

string

Name of the network security group.

regionId

string

System ID assigned to the Azure region to which the security group belongs to.

resourceGroupName

string

Name of the resource group associated with the network security group.

subscriptionId

string

Azure ID of the subscription where the network security group belongs.

SchemasAvailabilitySetV2

Property

Type

Description

id

string

Azure ID assigned to the availability set.

name

string

Name of the Availability Set.

regionName

string

Name of the Azure region where the availability set is located.

I want to report a typo

There is a misspelling right here:

 

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