Share via

AzureVmWorkloadProtectedItem interface

  • Reference
Package:
@azure/arm-recoveryservicesbackup

Azure VM workload-specific protected item.

Extends
ProtectedItem

Properties

extendedInfo

Additional information for this backup item.
friendlyName

Friendly name of the DB represented by this backup item. NOTE: This property will not be serialized. It can only be populated by the server.
kpisHealths

Health details of different KPIs
lastBackupErrorDetail

Error details in last backup
lastBackupStatus

Last backup operation status. Possible values: Healthy, Unhealthy.
lastBackupTime

Timestamp of the last backup operation on this backup item.
nodesList

List of the nodes in case of distributed container.
parentName

Parent name of the DB such as Instance or Availability Group.
parentType

Parent type of protected item, example: for a DB, standalone server or distributed
protectedItemDataSourceId

Data ID of the protected item.
protectedItemHealthStatus

Health status of the backup item, evaluated based on last heartbeat received
protectedItemType

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

Backup state of this backup item.
protectionStatus

Backup status of this backup item. NOTE: This property will not be serialized. It can only be populated by the server.
serverName

Host/Cluster Name for instance or AG

Inherited Properties

backupManagementType

Type of backup management for the backed up item. NOTE: This property will not be serialized. It can only be populated by the server.
backupSetName

Name of the backup set the backup item belongs to
containerName

Unique name of container
createMode

Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
deferredDeleteTimeInUTC

Time for deferred deletion in UTC
deferredDeleteTimeRemaining

Time remaining before the DS marked for deferred delete is permanently deleted
isArchiveEnabled

Flag to identify whether datasource is protected in archive
isDeferredDeleteScheduleUpcoming

Flag to identify whether the deferred deleted DS is to be purged soon
isRehydrate

Flag to identify that deferred deleted DS is to be moved into Pause state
isScheduledForDeferredDelete

Flag to identify whether the DS is scheduled for deferred delete
lastRecoveryPoint

Timestamp when the last (latest) backup copy was created for this backup item.
policyId

ID of the backup policy with which this item is backed up.
policyName

Name of the policy used for protection
resourceGuardOperationRequests

ResourceGuardOperationRequests on which LAC check will be performed
softDeleteRetentionPeriodInDays

Soft delete retention period in days
sourceResourceId

ARM ID of the resource to be backed up.
vaultId

ID of the vault which protects this item NOTE: This property will not be serialized. It can only be populated by the server.
workloadType

Type of workload this item represents. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

extendedInfo

Additional information for this backup item.

extendedInfo?: AzureVmWorkloadProtectedItemExtendedInfo

Property Value

AzureVmWorkloadProtectedItemExtendedInfo

friendlyName

Friendly name of the DB represented by this backup item. NOTE: This property will not be serialized. It can only be populated by the server.

friendlyName?: string

Property Value

string

kpisHealths

Health details of different KPIs

kpisHealths?: {[propertyName: string]: KPIResourceHealthDetails}

Property Value

{[propertyName: string]: KPIResourceHealthDetails}

lastBackupErrorDetail

Error details in last backup

lastBackupErrorDetail?: ErrorDetail

Property Value

ErrorDetail

lastBackupStatus

Last backup operation status. Possible values: Healthy, Unhealthy.

lastBackupStatus?: string

Property Value

string

lastBackupTime

Timestamp of the last backup operation on this backup item.

lastBackupTime?: Date

Property Value

Date

nodesList

List of the nodes in case of distributed container.

nodesList?: DistributedNodesInfo[]

Property Value

DistributedNodesInfo[]

parentName

Parent name of the DB such as Instance or Availability Group.

parentName?: string

Property Value

string

parentType

Parent type of protected item, example: for a DB, standalone server or distributed

parentType?: string

Property Value

string

protectedItemDataSourceId

Data ID of the protected item.

protectedItemDataSourceId?: string

Property Value

string

protectedItemHealthStatus

Health status of the backup item, evaluated based on last heartbeat received

protectedItemHealthStatus?: string

Property Value

string

protectedItemType

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

protectedItemType: "AzureVmWorkloadProtectedItem" | "AzureVmWorkloadSAPAseDatabase" | "AzureVmWorkloadSAPHanaDatabase" | "AzureVmWorkloadSAPHanaDBInstance" | "AzureVmWorkloadSQLDatabase"

Property Value

"AzureVmWorkloadProtectedItem" | "AzureVmWorkloadSAPAseDatabase" | "AzureVmWorkloadSAPHanaDatabase" | "AzureVmWorkloadSAPHanaDBInstance" | "AzureVmWorkloadSQLDatabase"

protectionState

Backup state of this backup item.

protectionState?: string

Property Value

string

protectionStatus

Backup status of this backup item. NOTE: This property will not be serialized. It can only be populated by the server.

protectionStatus?: string

Property Value

string

serverName

Host/Cluster Name for instance or AG

serverName?: string

Property Value

string

Inherited Property Details

backupManagementType

Type of backup management for the backed up item. NOTE: This property will not be serialized. It can only be populated by the server.

backupManagementType?: string

Property Value

string

Inherited From ProtectedItem.backupManagementType

backupSetName

Name of the backup set the backup item belongs to

backupSetName?: string

Property Value

string

Inherited From ProtectedItem.backupSetName

containerName

Unique name of container

containerName?: string

Property Value

string

Inherited From ProtectedItem.containerName

createMode

Create mode to indicate recovery of existing soft deleted data source or creation of new data source.

createMode?: string

Property Value

string

Inherited From ProtectedItem.createMode

deferredDeleteTimeInUTC

Time for deferred deletion in UTC

deferredDeleteTimeInUTC?: Date

Property Value

Date

Inherited From ProtectedItem.deferredDeleteTimeInUTC

deferredDeleteTimeRemaining

Time remaining before the DS marked for deferred delete is permanently deleted

deferredDeleteTimeRemaining?: string

Property Value

string

Inherited From ProtectedItem.deferredDeleteTimeRemaining

isArchiveEnabled

Flag to identify whether datasource is protected in archive

isArchiveEnabled?: boolean

Property Value

boolean

Inherited From ProtectedItem.isArchiveEnabled

isDeferredDeleteScheduleUpcoming

Flag to identify whether the deferred deleted DS is to be purged soon

isDeferredDeleteScheduleUpcoming?: boolean

Property Value

boolean

Inherited From ProtectedItem.isDeferredDeleteScheduleUpcoming

isRehydrate

Flag to identify that deferred deleted DS is to be moved into Pause state

isRehydrate?: boolean

Property Value

boolean

Inherited From ProtectedItem.isRehydrate

isScheduledForDeferredDelete

Flag to identify whether the DS is scheduled for deferred delete

isScheduledForDeferredDelete?: boolean

Property Value

boolean

Inherited From ProtectedItem.isScheduledForDeferredDelete

lastRecoveryPoint

Timestamp when the last (latest) backup copy was created for this backup item.

lastRecoveryPoint?: Date

Property Value

Date

Inherited From ProtectedItem.lastRecoveryPoint

policyId

ID of the backup policy with which this item is backed up.

policyId?: string

Property Value

string

Inherited From ProtectedItem.policyId

policyName

Name of the policy used for protection

policyName?: string

Property Value

string

Inherited From ProtectedItem.policyName

resourceGuardOperationRequests

ResourceGuardOperationRequests on which LAC check will be performed

resourceGuardOperationRequests?: string[]

Property Value

string[]

Inherited From ProtectedItem.resourceGuardOperationRequests

softDeleteRetentionPeriodInDays

Soft delete retention period in days

softDeleteRetentionPeriodInDays?: number

Property Value

number

Inherited From ProtectedItem.softDeleteRetentionPeriodInDays

sourceResourceId

ARM ID of the resource to be backed up.

sourceResourceId?: string

Property Value

string

Inherited From ProtectedItem.sourceResourceId

vaultId

ID of the vault which protects this item NOTE: This property will not be serialized. It can only be populated by the server.

vaultId?: string

Property Value

string

Inherited From ProtectedItem.vaultId

workloadType

Type of workload this item represents. NOTE: This property will not be serialized. It can only be populated by the server.

workloadType?: string

Property Value

string

Inherited From ProtectedItem.workloadType