BackupEngineBase interface

The base backup engine class. All workload specific backup engines derive from this class.

Properties

azureBackupAgentVersion

Backup agent version

backupEngineId

ID of the backup engine.

backupEngineState

Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}

backupEngineType

Polymorphic discriminator, which specifies the different types this object can be

backupManagementType

Type of backup management for the backup engine.

canReRegister

Flag indicating if the backup engine be registered, once already registered.

dpmVersion

Backup engine version

extendedInfo

Extended info of the backupengine

friendlyName

Friendly name of the backup engine.

healthStatus

Backup status of the backup engine.

isAzureBackupAgentUpgradeAvailable

To check if backup agent upgrade available

isDpmUpgradeAvailable

To check if backup engine upgrade available

registrationStatus

Registration status of the backup engine with the Recovery Services Vault.

Property Details

azureBackupAgentVersion

Backup agent version

azureBackupAgentVersion?: string

Property Value

string

backupEngineId

ID of the backup engine.

backupEngineId?: string

Property Value

string

backupEngineState

Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed}

backupEngineState?: string

Property Value

string

backupEngineType

Polymorphic discriminator, which specifies the different types this object can be

backupEngineType: "AzureBackupServerEngine" | "DpmBackupEngine"

Property Value

"AzureBackupServerEngine" | "DpmBackupEngine"

backupManagementType

Type of backup management for the backup engine.

backupManagementType?: string

Property Value

string

canReRegister

Flag indicating if the backup engine be registered, once already registered.

canReRegister?: boolean

Property Value

boolean

dpmVersion

Backup engine version

dpmVersion?: string

Property Value

string

extendedInfo

Extended info of the backupengine

extendedInfo?: BackupEngineExtendedInfo

Property Value

friendlyName

Friendly name of the backup engine.

friendlyName?: string

Property Value

string

healthStatus

Backup status of the backup engine.

healthStatus?: string

Property Value

string

isAzureBackupAgentUpgradeAvailable

To check if backup agent upgrade available

isAzureBackupAgentUpgradeAvailable?: boolean

Property Value

boolean

isDpmUpgradeAvailable

To check if backup engine upgrade available

isDpmUpgradeAvailable?: boolean

Property Value

boolean

registrationStatus

Registration status of the backup engine with the Recovery Services Vault.

registrationStatus?: string

Property Value

string