AzureVmWorkloadSQLDatabaseProtectedItem interface

Package:

@azure/arm-recoveryservicesbackup

Azure VM workload-specific protected item representing SQL Database.

Extends

AzureVmWorkloadProtectedItem

Properties

parentProtectedItem	Name of the parent protected item (e.g., SQL Instance name) when this database is protected as part of a parent.
protectedItemType	This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
protectionLevel	Protection type in case protected as part of a parent.

Inherited Properties

backupManagementType	Type of backup management for the backed up item.
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
extendedInfo	Additional information for this backup item.
friendlyName	Friendly name of the DB represented by this backup item.
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
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.
lastRecoveryPoint	Timestamp when the last (latest) backup copy was created for 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
policyId	ID of the backup policy with which this item is backed up.
policyName	Name of the policy used for protection
protectedItemDataSourceId	Data ID of the protected item.
protectedItemHealthStatus	Health status of the backup item, evaluated based on last heartbeat received
protectionState	Backup state of this backup item.
protectionStatus	Backup status of this backup item.
resourceGuardOperationRequests	ResourceGuardOperationRequests on which LAC check will be performed
serverName	Host/Cluster Name for instance or AG
softDeleteRetentionPeriodInDays	Soft delete retention period in days
sourceResourceId	ARM ID of the resource to be backed up.
sourceSideScanInfo	Source side threat information
vaultId	ID of the vault which protects this item
workloadType	Type of workload this item represents.

Property Details

parentProtectedItem

Name of the parent protected item (e.g., SQL Instance name) when this database is protected as part of a parent.

parentProtectedItem?: string

Property Value

string

protectedItemType

This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.

protectedItemType: "AzureVmWorkloadSQLDatabase"

Property Value

"AzureVmWorkloadSQLDatabase"

protectionLevel

Protection type in case protected as part of a parent.

protectionLevel?: string

Property Value

string

Inherited Property Details

backupManagementType

Type of backup management for the backed up item.

backupManagementType?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.backupManagementType

backupSetName

Name of the backup set the backup item belongs to

backupSetName?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.backupSetName

containerName

Unique name of container

containerName?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.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 AzureVmWorkloadProtectedItem.createMode

deferredDeleteTimeInUTC

Time for deferred deletion in UTC

deferredDeleteTimeInUTC?: Date

Property Value

Date

Inherited From AzureVmWorkloadProtectedItem.deferredDeleteTimeInUTC

deferredDeleteTimeRemaining

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

deferredDeleteTimeRemaining?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.deferredDeleteTimeRemaining

extendedInfo

Additional information for this backup item.

extendedInfo?: AzureVmWorkloadProtectedItemExtendedInfo

Property Value

AzureVmWorkloadProtectedItemExtendedInfo

Inherited From AzureVmWorkloadProtectedItem.extendedInfo

friendlyName

Friendly name of the DB represented by this backup item.

friendlyName?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.friendlyName

isArchiveEnabled

Flag to identify whether datasource is protected in archive

isArchiveEnabled?: boolean

Property Value

boolean

Inherited From AzureVmWorkloadProtectedItem.isArchiveEnabled

isDeferredDeleteScheduleUpcoming

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

isDeferredDeleteScheduleUpcoming?: boolean

Property Value

boolean

Inherited From AzureVmWorkloadProtectedItem.isDeferredDeleteScheduleUpcoming

isRehydrate

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

isRehydrate?: boolean

Property Value

boolean

Inherited From AzureVmWorkloadProtectedItem.isRehydrate

isScheduledForDeferredDelete

Flag to identify whether the DS is scheduled for deferred delete

isScheduledForDeferredDelete?: boolean

Property Value

boolean

Inherited From AzureVmWorkloadProtectedItem.isScheduledForDeferredDelete

kpisHealths

Health details of different KPIs

kpisHealths?: Record<string, KPIResourceHealthDetails>

Property Value

Record<string, KPIResourceHealthDetails>

Inherited From AzureVmWorkloadProtectedItem.kpisHealths

lastBackupErrorDetail

Error details in last backup

lastBackupErrorDetail?: ErrorDetail

Property Value

ErrorDetail

Inherited From AzureVmWorkloadProtectedItem.lastBackupErrorDetail

lastBackupStatus

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

lastBackupStatus?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.lastBackupStatus

lastBackupTime

Timestamp of the last backup operation on this backup item.

lastBackupTime?: Date

Property Value

Date

Inherited From AzureVmWorkloadProtectedItem.lastBackupTime

lastRecoveryPoint

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

lastRecoveryPoint?: Date

Property Value

Date

Inherited From AzureVmWorkloadProtectedItem.lastRecoveryPoint

nodesList

List of the nodes in case of distributed container.

nodesList?: DistributedNodesInfo[]

Property Value

DistributedNodesInfo[]

Inherited From AzureVmWorkloadProtectedItem.nodesList

parentName

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

parentName?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.parentName

parentType

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

parentType?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.parentType

policyId

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

policyId?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.policyId

policyName

Name of the policy used for protection

policyName?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.policyName

protectedItemDataSourceId

Data ID of the protected item.

protectedItemDataSourceId?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.protectedItemDataSourceId

protectedItemHealthStatus

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

protectedItemHealthStatus?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.protectedItemHealthStatus

protectionState

Backup state of this backup item.

protectionState?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.protectionState

protectionStatus

Backup status of this backup item.

protectionStatus?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.protectionStatus

resourceGuardOperationRequests

ResourceGuardOperationRequests on which LAC check will be performed

resourceGuardOperationRequests?: string[]

Property Value

string[]

Inherited From AzureVmWorkloadProtectedItem.resourceGuardOperationRequests

serverName

Host/Cluster Name for instance or AG

serverName?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.serverName

softDeleteRetentionPeriodInDays

Soft delete retention period in days

softDeleteRetentionPeriodInDays?: number

Property Value

number

Inherited From AzureVmWorkloadProtectedItem.softDeleteRetentionPeriodInDays

sourceResourceId

ARM ID of the resource to be backed up.

sourceResourceId?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.sourceResourceId

sourceSideScanInfo

Source side threat information

sourceSideScanInfo?: SourceSideScanInfo

Property Value

SourceSideScanInfo

Inherited From AzureVmWorkloadProtectedItem.sourceSideScanInfo

vaultId

ID of the vault which protects this item

vaultId?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.vaultId

workloadType

Type of workload this item represents.

workloadType?: string

Property Value

string

Inherited From AzureVmWorkloadProtectedItem.workloadType