Schemas

In this article

    The following JSON schemas are used to represent resources in the /databases collection in the Veeam Backup for Microsoft Azure REST API. Properties included in schemas represent Azure SQL backup policy settings. Some of the properties can be used in POST and PUT requests as well as for query parameter values in GET requests.

    SchemasDatabaseV3

    Property

    Type

    Description

    id

    string

    System ID assigned to the Azure SQL database in Veeam Backup for Microsoft Azure.

    resourceId

    string

    Azure ID assigned to the Azure SQL database.

    name

    string

    Name of the Azure SQL database.

    serverName

    string

    Name of a server hosting database.

    serverId

    string

    Azure ID assigned to the server hosting the database.

    resourceGroupName

    string

    Information on a resource group where the backup item belongs.

    sizeInMb

    integer

    Size of the database.

    subscriptionId

    string

    Information on an Azure subscription to which the backup item belongs.

    regionId

    string

    Name of the Azure region where the database resides.

    hasElasticPool

    boolean

    Defines whether the database belongs to an elastic pool.

    status

    array[string]

    Status of the database: Other, Online, Restoring, RecoveryPending, Recovering, Suspect, Offline, Standby, Shutdown, EmergencyMode, AutoClosed, Copying, Creating, Inaccessible, OfflineSecondary, Pausing, Paused, Resuming, Scaling, OfflineChangingDwPerformanceTiers, OnlineChangingDwPerformanceTiers, Disabled.

    databaseType

    array[string]

    Type of the database: Managed, Unmanaged.

    _links

    array[string]

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

    SchemasSqlManualBackupSettingsV3

    Property

    Type

    Description

    databaseIds

    string

    System ID assigned to the Azure SQL databases in Veeam Backup for Microsoft Azure.

    repositoryId

    string

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

    tenantId

    string

    Azure ID of the tenant.

    serviceAccountId

    string

    System ID assigned to the Azure service account whose permissions will be used to manage Azure SQL databases.

    managedStagingServerId

    string

    Azure ID assigned to the server hosting the database.

    stagingServerId

    string

    Azure ID assigned to the server that will be used as a staging server

    SchemasJobSessionV3

    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[string]

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

    SchemasBackupJobInfoV2

    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.

    SchemasRestoreJobInfoV2

    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.

    SchemasRecoveryItemV2

    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.

    SchemasFileLevelRestoreJobInfoV2

    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.

    SchemasRepositoryJobInfoV2

    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.

    SchemasRestorePointDataRetrievalJobInfoV3

    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)

    Number of days to keep restore points in configuration database.

    dataRetrievalPriority

    string

    Priotiry of data retrieval.

    SchemasRetentionJobInfoV3

    Property

    Type

    Description

    deletedRestorePointsCount

    integer($int32)

    Number of restore points removed from configuration database.