LongTermRetentionBackup interface

Package:

@azure/arm-sql

A long term retention backup.

Extends

ProxyResource

Properties

backupExpirationTime	The time the long term retention backup will expire. NOTE: This property will not be serialized. It can only be populated by the server.
backupStorageAccessTier	The BackupStorageAccessTier for the LTR backup NOTE: This property will not be serialized. It can only be populated by the server.
backupStorageRedundancy	The storage redundancy type of the backup NOTE: This property will not be serialized. It can only be populated by the server.
backupTime	The time the backup was taken NOTE: This property will not be serialized. It can only be populated by the server.
databaseDeletionTime	The delete time of the database NOTE: This property will not be serialized. It can only be populated by the server.
databaseName	The name of the database the backup belong to NOTE: This property will not be serialized. It can only be populated by the server.
isBackupImmutable	The setting whether the LTR backup is immutable
legalHoldImmutability	The setting for whether LegalHold is enabled or disabled on the LTR backup. When LegalHold is enabled, the backup cannot be deleted until the LegalHold is removed.
requestedBackupStorageRedundancy	The storage redundancy type of the backup
serverCreateTime	The create time of the server. NOTE: This property will not be serialized. It can only be populated by the server.
serverName	The server name that the backup database belong to. NOTE: This property will not be serialized. It can only be populated by the server.
timeBasedImmutability	The setting for whether or not time-based immutability is enabled for the LTR backup. When time-based immutability is enabled and locked, the backup cannot be deleted until BackupExpirationTime.
timeBasedImmutabilityMode	The time-based immutability mode. Only applicable if time-based immutability is enabled.

Inherited Properties

id	Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name	Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

backupExpirationTime

The time the long term retention backup will expire. NOTE: This property will not be serialized. It can only be populated by the server.

backupExpirationTime?: Date

Property Value

Date

backupStorageAccessTier

The BackupStorageAccessTier for the LTR backup NOTE: This property will not be serialized. It can only be populated by the server.

backupStorageAccessTier?: string

Property Value

string

backupStorageRedundancy

The storage redundancy type of the backup NOTE: This property will not be serialized. It can only be populated by the server.

backupStorageRedundancy?: string

Property Value

string

backupTime

The time the backup was taken NOTE: This property will not be serialized. It can only be populated by the server.

backupTime?: Date

Property Value

Date

databaseDeletionTime

The delete time of the database NOTE: This property will not be serialized. It can only be populated by the server.

databaseDeletionTime?: Date

Property Value

Date

databaseName

The name of the database the backup belong to NOTE: This property will not be serialized. It can only be populated by the server.

databaseName?: string

Property Value

string

isBackupImmutable

The setting whether the LTR backup is immutable

isBackupImmutable?: boolean

Property Value

boolean

legalHoldImmutability

The setting for whether LegalHold is enabled or disabled on the LTR backup. When LegalHold is enabled, the backup cannot be deleted until the LegalHold is removed.

legalHoldImmutability?: string

Property Value

string

requestedBackupStorageRedundancy

The storage redundancy type of the backup

requestedBackupStorageRedundancy?: string

Property Value

string

serverCreateTime

The create time of the server. NOTE: This property will not be serialized. It can only be populated by the server.

serverCreateTime?: Date

Property Value

Date

serverName

The server name that the backup database belong to. NOTE: This property will not be serialized. It can only be populated by the server.

serverName?: string

Property Value

string

timeBasedImmutability

The setting for whether or not time-based immutability is enabled for the LTR backup. When time-based immutability is enabled and locked, the backup cannot be deleted until BackupExpirationTime.

timeBasedImmutability?: string

Property Value

string

timeBasedImmutabilityMode

The time-based immutability mode. Only applicable if time-based immutability is enabled.

timeBasedImmutabilityMode?: string

Property Value

string

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type