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

JobSessionV3

The following properties represent the JobSessionv3 JSON schema.

JobSessionV3JobSessionV3

Property

Type

Description

id

string($uuid)

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

type

string

Type of the session: AutoBackup, BackupRetention, RestoreDisks, FileLevelRestore, ObsoleteSnapshotRetention, ManualSnapshot, PolicyBackup, PolicySnapshot, RestoreVms, BackupDeletion, SnapshotDeletion, RepositoryCreation, RepositoryDeletion, RepositoryEdit, ManualSnapshotDeletion, InvalidSnapshotRetention, OrphanedSnapshotRetention.

localizedType

string

Name of the session type displayed in the UI.

executionStartTime

string($date-time)

Date and time when the session started.

executionStopTime

string($date-time)

Date and time when the session finished or stopped.

executionDuration

integer($int64)

Time taken to complete the latest job session (in ms).

status

string

Status of the session: Canceled, Canceling, Error, NeverExecuted, Pending, Running, RunningWithError, RunningWithWarning, Success, Warning.

backupJobInfo

BackupJobInfoV2

Information on a backup policy session.

restoreJobInfo

RestoreJobInfoV3

Information on a restore session.

fileLevelRestoreJobInfo

FileLevelRestoreJobInfoV2

Information on a File-Level Restore session.

repositoryJobInfo

RepositoryJobInfoV2

Information on a backup repository added to the policy.

restorePointDataRetrievalJobInfo

RestorePointDataRetrievalJobInfoV3

Information on retrieved restore points.

retentionJobInfo

RetentionJobInfoV3

Information removed restore points.

_links

array

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

JobSessionV3BackupJobInfoV2

Property

Type

Description

policyId

string($uuid)

System ID assigned to a backup policy in the Veeam Backup for Microsoft Azure REST API.

policyName

string

Name of the backup policy.

protectedInstancesCount

integer($int32)

Number of protected Azure VMs.

policyRemoved

boolean

Defines whether the backup policy is no longer present in Veeam Backup for Microsoft Azure database.

JobSessionV3RestoreJobInfoV2

Property

Type

Description

reason

string

Trigger of the session.

vmId

string($uuid)

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

items

RecoveryItemv3

Specifies the restored items.

JobSessionV3RecoveryItemV2

Property

Type

Description

id

string

System ID assigned to the restored item in the Veeam Backup for Microsoft Azure REST API.

name

string

Name of the restored item.

type

string

Type of the restored item: VirtualMachine, Disk.

JobSessionV3FileLevelRestoreJobInfoV2

Property

Type

Description

initiator

string

Name of the user that launched File-Level Restore operation.

reason

string

Trigger of the session.

flrLink

FlrLinkv3

Request URL used to open the File-level Recovery browser.

vmId

string

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

restorePointCreatedDateUtc 

string($date-time)

Date and time when the restore point was created.

JobSessionV3RepositoryJobInfoV2

Property

Type

Description

repositoryId

string

System ID assigned to the repository in the Veeam Backup for Microsoft Azure REST API..

repositoryName

string

Name of the repository

repositoryRemoved

boolean

Defines whether the repository no longer exist.

JobSessionV3RestorePointDataRetrievalJobInfoV3

Property

Type

Description

restorePointId

string($uuid)

System ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

sqlRestorePointId

string($uuid)

System ID assigned to a restore point in the Veeam Backup for Microsoft Azure REST API.

initiator

string

Name of the user that launched restore point retrieval operation.

instanceName

string

Name of the

daysToKeep

integer($int32)

 

dataRetrievalPriority

string

 

JobSessionV3RetentionJobInfoV3

Property

Type

Description

deletedRestorePointsCount

integer($int32)

Number of restore points removed from configuration database.