Share via


BackupProperties interface

Backup properties

Properties

backupId

UUID v4 used to identify the Backup

backupPolicyResourceId

ResourceId used to identify the backup policy

backupType

Type of backup Manual or Scheduled

completionDate

The completion date of the backup

creationDate

The creation date of the backup

failureReason

Failure reason

isLargeVolume

Specifies if the backup is for a large volume.

label

Label for backup

provisioningState

Azure lifecycle management

size

Size of backup in bytes

snapshotCreationDate

The snapshot creation date of the backup

snapshotName

The name of the snapshot

useExistingSnapshot

Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups

volumeResourceId

ResourceId used to identify the Volume

Property Details

backupId

UUID v4 used to identify the Backup

backupId?: string

Property Value

string

backupPolicyResourceId

ResourceId used to identify the backup policy

backupPolicyResourceId?: string

Property Value

string

backupType

Type of backup Manual or Scheduled

backupType?: string

Property Value

string

completionDate

The completion date of the backup

completionDate?: null | Date

Property Value

null | Date

creationDate

The creation date of the backup

creationDate?: Date

Property Value

Date

failureReason

Failure reason

failureReason?: string

Property Value

string

isLargeVolume

Specifies if the backup is for a large volume.

isLargeVolume?: boolean

Property Value

boolean

label

Label for backup

label?: string

Property Value

string

provisioningState

Azure lifecycle management

provisioningState?: string

Property Value

string

size

Size of backup in bytes

size?: number

Property Value

number

snapshotCreationDate

The snapshot creation date of the backup

snapshotCreationDate?: null | Date

Property Value

null | Date

snapshotName

The name of the snapshot

snapshotName?: string

Property Value

string

useExistingSnapshot

Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups

useExistingSnapshot?: boolean

Property Value

boolean

volumeResourceId

ResourceId used to identify the Volume

volumeResourceId: string

Property Value

string