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

array[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

array[string]

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

backupJobInfo

BackupJobInfov3

Information on the backup policy session.

restoreJobInfo

RestoreJobInfov3

Information on the restore session.

fileLevelRestoreJobInfo

FileLevelRestoreJobInfov3

Information on the File-Level Restore session.

repositoryJobInfo

RepositoryJobInfov3

Information on the backup repository added to the policy.

_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 Azure VMs.protected by the backup policy.

policyRemoved

boolean

Defines whether the backup policy was removed from the configuration database.

JobSessionV3RestoreJobInfoV2

Property

Type

Description

reason

string

Trigger of the restore policy session.

vmId

string($uuid)

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

items

RecoveryItemv3

Information on 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 who 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 in the Veeam Backup for Microsoft Azure REST API assigned to an Azure VM added to the File-Level Restore policy.

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.