GetBackupByStorageQueryDescription
Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.
Properties
Name | Type | Required |
---|---|---|
StartDateTimeFilter |
string (date-time) | No |
EndDateTimeFilter |
string (date-time) | No |
Latest |
boolean | No |
Storage |
BackupStorageDescription | Yes |
BackupEntity |
BackupEntity | Yes |
StartDateTimeFilter
Type: string (date-time)
Required: No
Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning.
EndDateTimeFilter
Type: string (date-time)
Required: No
Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end.
Latest
Type: boolean
Required: No
Default: false
If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity.
Storage
Type: BackupStorageDescription
Required: Yes
Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore.
BackupEntity
Type: BackupEntity
Required: Yes
Indicates the entity for which to enumerate backups.