AzureSqlProtectedItem interface
Azure SQL workload-specific backup item.
- Extends
Properties
| extended |
Additional information for this backup item. |
| protected |
Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services. |
| protected |
Polymorphic discriminator, which specifies the different types this object can be |
| protection |
Backup state of the backed up 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
extendedInfo
Additional information for this backup item.
extendedInfo?: AzureSqlProtectedItemExtendedInfoProperty Value
protectedItemDataId
Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.
protectedItemDataId?: stringProperty Value
string
protectedItemType
Polymorphic discriminator, which specifies the different types this object can be
protectedItemType: "Microsoft.Sql/servers/databases"Property Value
"Microsoft.Sql/servers/databases"
protectionState
Backup state of the backed up item.
protectionState?: stringProperty 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?: stringProperty Value
string
Inherited From ProtectedItem.backupManagementType
backupSetName
Name of the backup set the backup item belongs to
backupSetName?: stringProperty Value
string
Inherited From ProtectedItem.backupSetName
containerName
Unique name of container
containerName?: stringProperty 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?: stringProperty Value
string
Inherited From ProtectedItem.createMode
deferredDeleteTimeInUTC
Time for deferred deletion in UTC
deferredDeleteTimeInUTC?: DateProperty Value
Date
Inherited From ProtectedItem.deferredDeleteTimeInUTC
deferredDeleteTimeRemaining
Time remaining before the DS marked for deferred delete is permanently deleted
deferredDeleteTimeRemaining?: stringProperty Value
string
Inherited From ProtectedItem.deferredDeleteTimeRemaining
isArchiveEnabled
Flag to identify whether datasource is protected in archive
isArchiveEnabled?: booleanProperty Value
boolean
Inherited From ProtectedItem.isArchiveEnabled
isDeferredDeleteScheduleUpcoming
Flag to identify whether the deferred deleted DS is to be purged soon
isDeferredDeleteScheduleUpcoming?: booleanProperty Value
boolean
Inherited From ProtectedItem.isDeferredDeleteScheduleUpcoming
isRehydrate
Flag to identify that deferred deleted DS is to be moved into Pause state
isRehydrate?: booleanProperty Value
boolean
Inherited From ProtectedItem.isRehydrate
isScheduledForDeferredDelete
Flag to identify whether the DS is scheduled for deferred delete
isScheduledForDeferredDelete?: booleanProperty Value
boolean
Inherited From ProtectedItem.isScheduledForDeferredDelete
lastRecoveryPoint
Timestamp when the last (latest) backup copy was created for this backup item.
lastRecoveryPoint?: DateProperty Value
Date
Inherited From ProtectedItem.lastRecoveryPoint
policyId
ID of the backup policy with which this item is backed up.
policyId?: stringProperty Value
string
Inherited From ProtectedItem.policyId
policyName
Name of the policy used for protection
policyName?: stringProperty 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?: numberProperty Value
number
Inherited From ProtectedItem.softDeleteRetentionPeriodInDays
sourceResourceId
ARM ID of the resource to be backed up.
sourceResourceId?: stringProperty 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?: stringProperty 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?: stringProperty Value
string
Inherited From ProtectedItem.workloadType