Package version:

Interface LongTermRetentionBackups

Interface representing a LongTermRetentionBackups.

Hierarchy

LongTermRetentionBackups

Methods

beginCopy

beginCopy(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyOptionalParams): Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>
Copy an existing long term retention backup.
Parameters
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- parameters: CopyLongTermRetentionBackupParameters
  
  The parameters needed for long term retention copy request
- Optional options: LongTermRetentionBackupsCopyOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:124

beginCopyAndWait

beginCopyAndWait(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyOptionalParams): Promise<LongTermRetentionBackupOperationResult>
Copy an existing long term retention backup.
Parameters
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- parameters: CopyLongTermRetentionBackupParameters
  
  The parameters needed for long term retention copy request
- Optional options: LongTermRetentionBackupsCopyOptionalParams
  
  The options parameters.
Returns Promise<LongTermRetentionBackupOperationResult>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:146

beginCopyByResourceGroup

beginCopyByResourceGroup(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyByResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>
Copy an existing long term retention backup to a different server.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- parameters: CopyLongTermRetentionBackupParameters
  
  The parameters needed for long term retention copy request
- Optional options: LongTermRetentionBackupsCopyByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:249

beginCopyByResourceGroupAndWait

beginCopyByResourceGroupAndWait(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: CopyLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsCopyByResourceGroupOptionalParams): Promise<LongTermRetentionBackupOperationResult>
Copy an existing long term retention backup to a different server.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- parameters: CopyLongTermRetentionBackupParameters
  
  The parameters needed for long term retention copy request
- Optional options: LongTermRetentionBackupsCopyByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<LongTermRetentionBackupOperationResult>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:274

beginDelete

beginDelete(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a long term retention backup.
Parameters
- locationName: string
  
  The location of the database
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionBackupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:216

beginDeleteAndWait

beginDeleteAndWait(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteOptionalParams): Promise<void>
Deletes a long term retention backup.
Parameters
- locationName: string
  
  The location of the database
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionBackupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:231

beginDeleteByResourceGroup

beginDeleteByResourceGroup(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a long term retention backup.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:356

beginDeleteByResourceGroupAndWait

beginDeleteByResourceGroupAndWait(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams): Promise<void>
Deletes a long term retention backup.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:374

beginUpdate

beginUpdate(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>
Updates an existing long term retention backup.
Parameters
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- parameters: UpdateLongTermRetentionBackupParameters
  
  The requested backup resource state
- Optional options: LongTermRetentionBackupsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:163

beginUpdateAndWait

beginUpdateAndWait(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateOptionalParams): Promise<LongTermRetentionBackupOperationResult>
Updates an existing long term retention backup.
Parameters
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- parameters: UpdateLongTermRetentionBackupParameters
  
  The requested backup resource state
- Optional options: LongTermRetentionBackupsUpdateOptionalParams
  
  The options parameters.
Returns Promise<LongTermRetentionBackupOperationResult>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:185

beginUpdateByResourceGroup

beginUpdateByResourceGroup(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams): Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>
Updates an existing long term retention backup.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- parameters: UpdateLongTermRetentionBackupParameters
  
  The requested backup resource state
- Optional options: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:294

beginUpdateByResourceGroupAndWait

beginUpdateByResourceGroupAndWait(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, parameters: UpdateLongTermRetentionBackupParameters, options?: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams): Promise<LongTermRetentionBackupOperationResult>
Updates an existing long term retention backup.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- parameters: UpdateLongTermRetentionBackupParameters
  
  The requested backup resource state
- Optional options: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<LongTermRetentionBackupOperationResult>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:319

get

get(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsGetOptionalParams): Promise<LongTermRetentionBackup>
Gets a long term retention backup.
Parameters
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionBackupsGetOptionalParams
  
  The options parameters.
Returns Promise<LongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:201

getByResourceGroup

getByResourceGroup(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, backupName: string, options?: LongTermRetentionBackupsGetByResourceGroupOptionalParams): Promise<LongTermRetentionBackup>
Gets a long term retention backup.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database.
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionBackupsGetByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<LongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:338

listByDatabase

listByDatabase(locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, options?: LongTermRetentionBackupsListByDatabaseOptionalParams): PagedAsyncIterableIterator<LongTermRetentionBackup>
Lists all long term retention backups for a database.
Parameters
- locationName: string
  
  The location of the database
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- Optional options: LongTermRetentionBackupsListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:47

listByLocation

listByLocation(locationName: string, options?: LongTermRetentionBackupsListByLocationOptionalParams): PagedAsyncIterableIterator<LongTermRetentionBackup>
Lists the long term retention backups for a given location.
Parameters
- locationName: string
  
  The location of the database
- Optional options: LongTermRetentionBackupsListByLocationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:58

listByResourceGroupDatabase

listByResourceGroupDatabase(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, longTermRetentionDatabaseName: string, options?: LongTermRetentionBackupsListByResourceGroupDatabaseOptionalParams): PagedAsyncIterableIterator<LongTermRetentionBackup>
Lists all long term retention backups for a database.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database
- longTermRetentionServerName: string
  
  The name of the server
- longTermRetentionDatabaseName: string
  
  The name of the database
- Optional options: LongTermRetentionBackupsListByResourceGroupDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:82

listByResourceGroupLocation

listByResourceGroupLocation(resourceGroupName: string, locationName: string, options?: LongTermRetentionBackupsListByResourceGroupLocationOptionalParams): PagedAsyncIterableIterator<LongTermRetentionBackup>
Lists the long term retention backups for a given location.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database
- Optional options: LongTermRetentionBackupsListByResourceGroupLocationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:96

listByResourceGroupServer

listByResourceGroupServer(resourceGroupName: string, locationName: string, longTermRetentionServerName: string, options?: LongTermRetentionBackupsListByResourceGroupServerOptionalParams): PagedAsyncIterableIterator<LongTermRetentionBackup>
Lists the long term retention backups for a given server.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- locationName: string
  
  The location of the database
- longTermRetentionServerName: string
  
  The name of the server
- Optional options: LongTermRetentionBackupsListByResourceGroupServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:109

listByServer

listByServer(locationName: string, longTermRetentionServerName: string, options?: LongTermRetentionBackupsListByServerOptionalParams): PagedAsyncIterableIterator<LongTermRetentionBackup>
Lists the long term retention backups for a given server.
Parameters
- locationName: string
  
  The location of the database
- longTermRetentionServerName: string
  
  The name of the server
- Optional options: LongTermRetentionBackupsListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionBackups.ts:68

Interface LongTermRetentionBackups

Hierarchy

Index

Methods

Methods

beginCopy

Parameters

locationName: string

longTermRetentionServerName: string

longTermRetentionDatabaseName: string

backupName: string

parameters: CopyLongTermRetentionBackupParameters

Optional options: LongTermRetentionBackupsCopyOptionalParams

Returns Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginCopyAndWait

Parameters

locationName: string

longTermRetentionServerName: string

longTermRetentionDatabaseName: string

backupName: string

parameters: CopyLongTermRetentionBackupParameters

Optional options: LongTermRetentionBackupsCopyOptionalParams

Returns Promise<LongTermRetentionBackupOperationResult>

beginCopyByResourceGroup

Parameters

resourceGroupName: string

locationName: string

longTermRetentionServerName: string

longTermRetentionDatabaseName: string

backupName: string

parameters: CopyLongTermRetentionBackupParameters

Optional options: LongTermRetentionBackupsCopyByResourceGroupOptionalParams

Returns Promise<SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginCopyByResourceGroupAndWait

Parameters

resourceGroupName: string

locationName: string

longTermRetentionServerName: string

longTermRetentionDatabaseName: string

backupName: string

parameters: CopyLongTermRetentionBackupParameters

Optional options: LongTermRetentionBackupsCopyByResourceGroupOptionalParams

Returns Promise<LongTermRetentionBackupOperationResult>

beginDelete

Parameters

locationName: string

longTermRetentionServerName: string

longTermRetentionDatabaseName: string

backupName: string

Optional options: LongTermRetentionBackupsDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

locationName: string

longTermRetentionServerName: string

longTermRetentionDatabaseName: string

backupName: string

Optional options: LongTermRetentionBackupsDeleteOptionalParams

Returns Promise<void>

beginDeleteByResourceGroup

Parameters

resourceGroupName: string

locationName: string

longTermRetentionServerName: string

longTermRetentionDatabaseName: string

backupName: string

Optional options: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteByResourceGroupAndWait

Parameters

resourceGroupName: string

locationName: string

longTermRetentionServerName: string

longTermRetentionDatabaseName: string

backupName: string

Optional options: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams

Returns Promise<void>

beginUpdate

Parameters

locationName: string

`Optional` options: LongTermRetentionBackupsCopyOptionalParams

`Optional` options: LongTermRetentionBackupsCopyOptionalParams

`Optional` options: LongTermRetentionBackupsCopyByResourceGroupOptionalParams

`Optional` options: LongTermRetentionBackupsCopyByResourceGroupOptionalParams

`Optional` options: LongTermRetentionBackupsDeleteOptionalParams

`Optional` options: LongTermRetentionBackupsDeleteOptionalParams

`Optional` options: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams

`Optional` options: LongTermRetentionBackupsDeleteByResourceGroupOptionalParams

`Optional` options: LongTermRetentionBackupsUpdateOptionalParams

`Optional` options: LongTermRetentionBackupsUpdateOptionalParams

`Optional` options: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams

`Optional` options: LongTermRetentionBackupsUpdateByResourceGroupOptionalParams

`Optional` options: LongTermRetentionBackupsGetOptionalParams

`Optional` options: LongTermRetentionBackupsGetByResourceGroupOptionalParams

`Optional` options: LongTermRetentionBackupsListByDatabaseOptionalParams

`Optional` options: LongTermRetentionBackupsListByLocationOptionalParams