GenericProtectedItem interface
Base class for backup items.
- Extends
Properties
fabric |
Name of this backup item's fabric. |
friendly |
Friendly name of the container. |
policy |
Indicates consistency of policy object and policy applied to this backup item. |
protected |
Data Plane Service ID of the protected item. |
protected |
Polymorphic discriminator, which specifies the different types this object can be |
protection |
Backup state of this backup item. |
source |
Loosely coupled (type, value) associations (example - parent of a protected item) |
Inherited Properties
backup |
Type of backup management for the backed up item. NOTE: This property will not be serialized. It can only be populated by the server. |
backup |
Name of the backup set the backup item belongs to |
container |
Unique name of container |
create |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
deferred |
Time for deferred deletion in UTC |
deferred |
Time remaining before the DS marked for deferred delete is permanently deleted |
is |
Flag to identify whether datasource is protected in archive |
is |
Flag to identify whether the deferred deleted DS is to be purged soon |
is |
Flag to identify that deferred deleted DS is to be moved into Pause state |
is |
Flag to identify whether the DS is scheduled for deferred delete |
last |
Timestamp when the last (latest) backup copy was created for this backup item. |
policy |
ID of the backup policy with which this item is backed up. |
policy |
Name of the policy used for protection |
resource |
ResourceGuardOperationRequests on which LAC check will be performed |
soft |
Soft delete retention period in days |
source |
ARM ID of the resource to be backed up. |
vault |
ID of the vault which protects this item NOTE: This property will not be serialized. It can only be populated by the server. |
workload |
Type of workload this item represents. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
fabricName
Name of this backup item's fabric.
fabricName?: string
Property Value
string
friendlyName
Friendly name of the container.
friendlyName?: string
Property Value
string
policyState
Indicates consistency of policy object and policy applied to this backup item.
policyState?: string
Property Value
string
protectedItemId
Data Plane Service ID of the protected item.
protectedItemId?: number
Property Value
number
protectedItemType
Polymorphic discriminator, which specifies the different types this object can be
protectedItemType: "GenericProtectedItem"
Property Value
"GenericProtectedItem"
protectionState
Backup state of this backup item.
protectionState?: string
Property Value
string
sourceAssociations
Loosely coupled (type, value) associations (example - parent of a protected item)
sourceAssociations?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: 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