LongTermRetentionBackupsOperations interface

Package:
@azure/arm-sql

Interface representing a LongTermRetentionBackups operations.

Properties

beginChangeAccessTier
beginChangeAccessTierAndWait
beginChangeAccessTierByResourceGroup
beginChangeAccessTierByResourceGroupAndWait
beginCopy
beginCopyAndWait
beginCopyByResourceGroup
beginCopyByResourceGroupAndWait
beginDelete
beginDeleteAndWait
beginDeleteByResourceGroup
beginDeleteByResourceGroupAndWait
beginLockTimeBasedImmutability
beginLockTimeBasedImmutabilityAndWait
beginLockTimeBasedImmutabilityByResourceGroup
beginLockTimeBasedImmutabilityByResourceGroupAndWait
beginRemoveLegalHoldImmutability
beginRemoveLegalHoldImmutabilityAndWait
beginRemoveLegalHoldImmutabilityByResourceGroup
beginRemoveLegalHoldImmutabilityByResourceGroupAndWait
beginRemoveTimeBasedImmutability
beginRemoveTimeBasedImmutabilityAndWait
beginRemoveTimeBasedImmutabilityByResourceGroup
beginRemoveTimeBasedImmutabilityByResourceGroupAndWait
beginSetLegalHoldImmutability
beginSetLegalHoldImmutabilityAndWait
beginSetLegalHoldImmutabilityByResourceGroup
beginSetLegalHoldImmutabilityByResourceGroupAndWait
beginUpdate
beginUpdateAndWait
beginUpdateByResourceGroup
beginUpdateByResourceGroupAndWait
changeAccessTier

Change a long term retention backup access tier.
changeAccessTierByResourceGroup

Change a long term retention backup access tier.
copy

Copy an existing long term retention backup.
copyByResourceGroup

Copy an existing long term retention backup to a different server.
delete

Deletes a long term retention backup.
deleteByResourceGroup

Deletes a long term retention backup.
get

Gets a long term retention backup.
getByResourceGroup

Gets a long term retention backup.
listByDatabase

Lists all long term retention backups for a database.
listByLocation

Lists the long term retention backups for a given location.
listByResourceGroupDatabase

Lists all long term retention backups for a database based on a particular resource group.
listByResourceGroupLocation

Lists the long term retention backups for a given location based on resource group.
listByResourceGroupServer

Lists the long term retention backups for a given server based on resource groups.
listByServer

Lists the long term retention backups for a given server.
lockTimeBasedImmutability

Lock time based immutability of an existing long term retention backup.
lockTimeBasedImmutabilityByResourceGroup

Lock time based immutability of an existing long term retention backup.
removeLegalHoldImmutability

Remove legal hold immutability of an existing long term retention backup.
removeLegalHoldImmutabilityByResourceGroup

Remove legal hold immutability of an existing long term retention backup.
removeTimeBasedImmutability

Remove time based immutability of an existing long term retention backup.
removeTimeBasedImmutabilityByResourceGroup

Remove time based immutability of an existing long term retention backup.
setLegalHoldImmutability

Set legal hold immutability of an existing long term retention backup.
setLegalHoldImmutabilityByResourceGroup

Set legal hold immutability of an existing long term retention backup.
update

Updates an existing long term retention backup.
updateByResourceGroup

Updates an existing long term retention backup.

Property Details

beginChangeAccessTier

Warning

This API is now deprecated.

use changeAccessTier instead

beginChangeAccessTier: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginChangeAccessTierAndWait

Warning

This API is now deprecated.

use changeAccessTier instead

beginChangeAccessTierAndWait: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierOptionalParams) => Promise<LongTermRetentionBackup>

beginChangeAccessTierByResourceGroup

Warning

This API is now deprecated.

use changeAccessTierByResourceGroup instead

beginChangeAccessTierByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginChangeAccessTierByResourceGroupAndWait

Warning

This API is now deprecated.

use changeAccessTierByResourceGroup instead

beginChangeAccessTierByResourceGroupAndWait: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

beginCopy

Warning

This API is now deprecated.

use copy instead

beginCopy: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginCopyAndWait

Warning

This API is now deprecated.

use copy instead

beginCopyAndWait: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyOptionalParams) => Promise<LongTermRetentionBackupOperationResult>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyOptionalParams) => Promise<LongTermRetentionBackupOperationResult>

beginCopyByResourceGroup

Warning

This API is now deprecated.

use copyByResourceGroup instead

beginCopyByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginCopyByResourceGroupAndWait

Warning

This API is now deprecated.

use copyByResourceGroup instead

beginCopyByResourceGroupAndWait: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyByResourceGroupOptionalParams) => Promise<LongTermRetentionBackupOperationResult>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyByResourceGroupOptionalParams) => Promise<LongTermRetentionBackupOperationResult>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteOptionalParams) => Promise<void>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteOptionalParams) => Promise<void>

beginDeleteByResourceGroup

Warning

This API is now deprecated.

use deleteByResourceGroup instead

beginDeleteByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteByResourceGroupAndWait

Warning

This API is now deprecated.

use deleteByResourceGroup instead

beginDeleteByResourceGroupAndWait: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams) => Promise<void>

beginLockTimeBasedImmutability

Warning

This API is now deprecated.

use lockTimeBasedImmutability instead

beginLockTimeBasedImmutability: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginLockTimeBasedImmutabilityAndWait

Warning

This API is now deprecated.

use lockTimeBasedImmutability instead

beginLockTimeBasedImmutabilityAndWait: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityOptionalParams) => Promise<LongTermRetentionBackup>

beginLockTimeBasedImmutabilityByResourceGroup

Warning

This API is now deprecated.

use lockTimeBasedImmutabilityByResourceGroup instead

beginLockTimeBasedImmutabilityByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginLockTimeBasedImmutabilityByResourceGroupAndWait

Warning

This API is now deprecated.

use lockTimeBasedImmutabilityByResourceGroup instead

beginLockTimeBasedImmutabilityByResourceGroupAndWait: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

beginRemoveLegalHoldImmutability

Warning

This API is now deprecated.

use removeLegalHoldImmutability instead

beginRemoveLegalHoldImmutability: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginRemoveLegalHoldImmutabilityAndWait

Warning

This API is now deprecated.

use removeLegalHoldImmutability instead

beginRemoveLegalHoldImmutabilityAndWait: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityOptionalParams) => Promise<LongTermRetentionBackup>

beginRemoveLegalHoldImmutabilityByResourceGroup

Warning

This API is now deprecated.

use removeLegalHoldImmutabilityByResourceGroup instead

beginRemoveLegalHoldImmutabilityByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginRemoveLegalHoldImmutabilityByResourceGroupAndWait

Warning

This API is now deprecated.

use removeLegalHoldImmutabilityByResourceGroup instead

beginRemoveLegalHoldImmutabilityByResourceGroupAndWait: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

beginRemoveTimeBasedImmutability

Warning

This API is now deprecated.

use removeTimeBasedImmutability instead

beginRemoveTimeBasedImmutability: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginRemoveTimeBasedImmutabilityAndWait

Warning

This API is now deprecated.

use removeTimeBasedImmutability instead

beginRemoveTimeBasedImmutabilityAndWait: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityOptionalParams) => Promise<LongTermRetentionBackup>

beginRemoveTimeBasedImmutabilityByResourceGroup

Warning

This API is now deprecated.

use removeTimeBasedImmutabilityByResourceGroup instead

beginRemoveTimeBasedImmutabilityByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginRemoveTimeBasedImmutabilityByResourceGroupAndWait

Warning

This API is now deprecated.

use removeTimeBasedImmutabilityByResourceGroup instead

beginRemoveTimeBasedImmutabilityByResourceGroupAndWait: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

beginSetLegalHoldImmutability

Warning

This API is now deprecated.

use setLegalHoldImmutability instead

beginSetLegalHoldImmutability: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginSetLegalHoldImmutabilityAndWait

Warning

This API is now deprecated.

use setLegalHoldImmutability instead

beginSetLegalHoldImmutabilityAndWait: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityOptionalParams) => Promise<LongTermRetentionBackup>

beginSetLegalHoldImmutabilityByResourceGroup

Warning

This API is now deprecated.

use setLegalHoldImmutabilityByResourceGroup instead

beginSetLegalHoldImmutabilityByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>>

beginSetLegalHoldImmutabilityByResourceGroupAndWait

Warning

This API is now deprecated.

use setLegalHoldImmutabilityByResourceGroup instead

beginSetLegalHoldImmutabilityByResourceGroupAndWait: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateOptionalParams) => Promise<LongTermRetentionBackupOperationResult>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateOptionalParams) => Promise<LongTermRetentionBackupOperationResult>

beginUpdateByResourceGroup

Warning

This API is now deprecated.

use updateByResourceGroup instead

beginUpdateByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams) => Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginUpdateByResourceGroupAndWait

Warning

This API is now deprecated.

use updateByResourceGroup instead

beginUpdateByResourceGroupAndWait: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams) => Promise<LongTermRetentionBackupOperationResult>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams) => Promise<LongTermRetentionBackupOperationResult>

changeAccessTier

Change a long term retention backup access tier.

changeAccessTier: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

changeAccessTierByResourceGroup

Change a long term retention backup access tier.

changeAccessTierByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: ChangeLongTermRetentionBackupAccessTierParameters, options?: LongTermRetentionBackupsChangeAccessTierByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

copy

Copy an existing long term retention backup.

copy: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyOptionalParams) => PollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyOptionalParams) => PollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>

copyByResourceGroup

Copy an existing long term retention backup to a different server.

copyByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>

delete

Deletes a long term retention backup.

delete: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

deleteByResourceGroup

Deletes a long term retention backup.

deleteByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a long term retention backup.

get: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsGetOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsGetOptionalParams) => Promise<LongTermRetentionBackup>

getByResourceGroup

Gets a long term retention backup.

getByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsGetByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsGetByResourceGroupOptionalParams) => Promise<LongTermRetentionBackup>

listByDatabase

Lists all long term retention backups for a database.

listByDatabase: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, options?: LongTermRetentionBackupsListByDatabaseOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, options?: LongTermRetentionBackupsListByDatabaseOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByLocation

Lists the long term retention backups for a given location.

listByLocation: (locationName: string, options?: LongTermRetentionBackupsListByLocationOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

Property Value

(locationName: string, options?: LongTermRetentionBackupsListByLocationOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByResourceGroupDatabase

Lists all long term retention backups for a database based on a particular resource group.

listByResourceGroupDatabase: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, options?: LongTermRetentionBackupsListByResourceGroupDatabaseOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, options?: LongTermRetentionBackupsListByResourceGroupDatabaseOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByResourceGroupLocation

Lists the long term retention backups for a given location based on resource group.

listByResourceGroupLocation: (resourceGroupName: string, locationName: string, options?: LongTermRetentionBackupsListByResourceGroupLocationOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

Property Value

(resourceGroupName: string, locationName: string, options?: LongTermRetentionBackupsListByResourceGroupLocationOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByResourceGroupServer

Lists the long term retention backups for a given server based on resource groups.

listByResourceGroupServer: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, options?: LongTermRetentionBackupsListByResourceGroupServerOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, options?: LongTermRetentionBackupsListByResourceGroupServerOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByServer

Lists the long term retention backups for a given server.

listByServer: (locationName: string, longTermRetentionServerName: string, options?: LongTermRetentionBackupsListByServerOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

Property Value

(locationName: string, longTermRetentionServerName: string, options?: LongTermRetentionBackupsListByServerOptionalParams) => PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

lockTimeBasedImmutability

Lock time based immutability of an existing long term retention backup.

lockTimeBasedImmutability: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

lockTimeBasedImmutabilityByResourceGroup

Lock time based immutability of an existing long term retention backup.

lockTimeBasedImmutabilityByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsLockTimeBasedImmutabilityByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

removeLegalHoldImmutability

Remove legal hold immutability of an existing long term retention backup.

removeLegalHoldImmutability: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

removeLegalHoldImmutabilityByResourceGroup

Remove legal hold immutability of an existing long term retention backup.

removeLegalHoldImmutabilityByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveLegalHoldImmutabilityByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

removeTimeBasedImmutability

Remove time based immutability of an existing long term retention backup.

removeTimeBasedImmutability: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

removeTimeBasedImmutabilityByResourceGroup

Remove time based immutability of an existing long term retention backup.

removeTimeBasedImmutabilityByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsRemoveTimeBasedImmutabilityByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

setLegalHoldImmutability

Set legal hold immutability of an existing long term retention backup.

setLegalHoldImmutability: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

setLegalHoldImmutabilityByResourceGroup

Set legal hold immutability of an existing long term retention backup.

setLegalHoldImmutabilityByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsSetLegalHoldImmutabilityByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackup>, LongTermRetentionBackup>

update

Updates an existing long term retention backup.

update: (locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateOptionalParams) => PollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>

Property Value

(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateOptionalParams) => PollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>

updateByResourceGroup

Updates an existing long term retention backup.

updateByResourceGroup: (resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>

Property Value

(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams) => PollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>