LongTermRetentionBackups interface

Package:

@azure/arm-sql

Interface representing a LongTermRetentionBackups.

Methods

beginCopy(string, string, string, string, CopyLongTermRetentionBackupParameters, LongTermRetentionBackupsCopyOptionalParams)	Copy an existing long term retention backup.
beginCopyAndWait(string, string, string, string, CopyLongTermRetentionBackupParameters, LongTermRetentionBackupsCopyOptionalParams)	Copy an existing long term retention backup.
beginCopyByResourceGroup(string, string, string, string, string, CopyLongTermRetentionBackupParameters, LongTermRetentionBackupsCopyByResourceGroupOptionalParams)	Copy an existing long term retention backup to a different server.
beginCopyByResourceGroupAndWait(string, string, string, string, string, CopyLongTermRetentionBackupParameters, LongTermRetentionBackupsCopyByResourceGroupOptionalParams)	Copy an existing long term retention backup to a different server.
beginDelete(string, string, string, string, LongTermRetentionBackupsDeleteOptionalParams)	Deletes a long term retention backup.
beginDeleteAndWait(string, string, string, string, LongTermRetentionBackupsDeleteOptionalParams)	Deletes a long term retention backup.
beginDeleteByResourceGroup(string, string, string, string, string, LongTermRetentionBackupsDeleteByResourceGroupOptionalParams)	Deletes a long term retention backup.
beginDeleteByResourceGroupAndWait(string, string, string, string, string, LongTermRetentionBackupsDeleteByResourceGroupOptionalParams)	Deletes a long term retention backup.
beginUpdate(string, string, string, string, UpdateLongTermRetentionBackupParameters, LongTermRetentionBackupsUpdateOptionalParams)	Updates an existing long term retention backup.
beginUpdateAndWait(string, string, string, string, UpdateLongTermRetentionBackupParameters, LongTermRetentionBackupsUpdateOptionalParams)	Updates an existing long term retention backup.
beginUpdateByResourceGroup(string, string, string, string, string, UpdateLongTermRetentionBackupParameters, LongTermRetentionBackupsUpdateByResourceGroupOptionalParams)	Updates an existing long term retention backup.
beginUpdateByResourceGroupAndWait(string, string, string, string, string, UpdateLongTermRetentionBackupParameters, LongTermRetentionBackupsUpdateByResourceGroupOptionalParams)	Updates an existing long term retention backup.
get(string, string, string, string, LongTermRetentionBackupsGetOptionalParams)	Gets a long term retention backup.
getByResourceGroup(string, string, string, string, string, LongTermRetentionBackupsGetByResourceGroupOptionalParams)	Gets a long term retention backup.
listByDatabase(string, string, string, LongTermRetentionBackupsListByDatabaseOptionalParams)	Lists all long term retention backups for a database.
listByLocation(string, LongTermRetentionBackupsListByLocationOptionalParams)	Lists the long term retention backups for a given location.
listByResourceGroupDatabase(string, string, string, string, LongTermRetentionBackupsListByResourceGroupDatabaseOptionalParams)	Lists all long term retention backups for a database.
listByResourceGroupLocation(string, string, LongTermRetentionBackupsListByResourceGroupLocationOptionalParams)	Lists the long term retention backups for a given location.
listByResourceGroupServer(string, string, string, LongTermRetentionBackupsListByResourceGroupServerOptionalParams)	Lists the long term retention backups for a given server.
listByServer(string, string, LongTermRetentionBackupsListByServerOptionalParams)	Lists the long term retention backups for a given server.

Method Details

beginCopy(string, string, string, string, CopyLongTermRetentionBackupParameters, LongTermRetentionBackupsCopyOptionalParams)

Copy an existing long term retention backup.

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

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

options

LongTermRetentionBackupsCopyOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginCopyAndWait(string, string, string, string, CopyLongTermRetentionBackupParameters, LongTermRetentionBackupsCopyOptionalParams)

Copy an existing long term retention backup.

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

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

options

LongTermRetentionBackupsCopyOptionalParams

The options parameters.

Returns

Promise<LongTermRetentionBackupOperationResult>

beginCopyByResourceGroup(string, string, string, string, string, CopyLongTermRetentionBackupParameters, LongTermRetentionBackupsCopyByResourceGroupOptionalParams)

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

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

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

options

LongTermRetentionBackupsCopyByResourceGroupOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginCopyByResourceGroupAndWait(string, string, string, string, string, CopyLongTermRetentionBackupParameters, LongTermRetentionBackupsCopyByResourceGroupOptionalParams)

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

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

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

options

LongTermRetentionBackupsCopyByResourceGroupOptionalParams

The options parameters.

Returns

Promise<LongTermRetentionBackupOperationResult>

beginDelete(string, string, string, string, LongTermRetentionBackupsDeleteOptionalParams)

Deletes a long term retention backup.

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

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.

options

LongTermRetentionBackupsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, string, LongTermRetentionBackupsDeleteOptionalParams)

Deletes a long term retention backup.

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

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.

options

LongTermRetentionBackupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteByResourceGroup(string, string, string, string, string, LongTermRetentionBackupsDeleteByResourceGroupOptionalParams)

Deletes a long term retention backup.

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

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.

options

LongTermRetentionBackupsDeleteByResourceGroupOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteByResourceGroupAndWait(string, string, string, string, string, LongTermRetentionBackupsDeleteByResourceGroupOptionalParams)

Deletes a long term retention backup.

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

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.

options

LongTermRetentionBackupsDeleteByResourceGroupOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, UpdateLongTermRetentionBackupParameters, LongTermRetentionBackupsUpdateOptionalParams)

Updates an existing long term retention backup.

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

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

options

LongTermRetentionBackupsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginUpdateAndWait(string, string, string, string, UpdateLongTermRetentionBackupParameters, LongTermRetentionBackupsUpdateOptionalParams)

Updates an existing long term retention backup.

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

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

options

LongTermRetentionBackupsUpdateOptionalParams

The options parameters.

Returns

Promise<LongTermRetentionBackupOperationResult>

beginUpdateByResourceGroup(string, string, string, string, string, UpdateLongTermRetentionBackupParameters, LongTermRetentionBackupsUpdateByResourceGroupOptionalParams)

Updates an existing long term retention backup.

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

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

options

LongTermRetentionBackupsUpdateByResourceGroupOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<LongTermRetentionBackupOperationResult>, LongTermRetentionBackupOperationResult>>

beginUpdateByResourceGroupAndWait(string, string, string, string, string, UpdateLongTermRetentionBackupParameters, LongTermRetentionBackupsUpdateByResourceGroupOptionalParams)

Updates an existing long term retention backup.

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

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

options

LongTermRetentionBackupsUpdateByResourceGroupOptionalParams

The options parameters.

Returns

Promise<LongTermRetentionBackupOperationResult>

get(string, string, string, string, LongTermRetentionBackupsGetOptionalParams)

Gets a long term retention backup.

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

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.

options

LongTermRetentionBackupsGetOptionalParams

The options parameters.

Returns

Promise<LongTermRetentionBackup>

getByResourceGroup(string, string, string, string, string, LongTermRetentionBackupsGetByResourceGroupOptionalParams)

Gets a long term retention backup.

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

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.

options

LongTermRetentionBackupsGetByResourceGroupOptionalParams

The options parameters.

Returns

Promise<LongTermRetentionBackup>

listByDatabase(string, string, string, LongTermRetentionBackupsListByDatabaseOptionalParams)

Lists all long term retention backups for a database.

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

Parameters

locationName

string

The location of the database

longTermRetentionServerName

string

The name of the server

longTermRetentionDatabaseName

string

The name of the database

options

LongTermRetentionBackupsListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByLocation(string, LongTermRetentionBackupsListByLocationOptionalParams)

Lists the long term retention backups for a given location.

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

Parameters

locationName

string

The location of the database

options

LongTermRetentionBackupsListByLocationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByResourceGroupDatabase(string, string, string, string, LongTermRetentionBackupsListByResourceGroupDatabaseOptionalParams)

Lists all long term retention backups for a database.

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

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

options

LongTermRetentionBackupsListByResourceGroupDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByResourceGroupLocation(string, string, LongTermRetentionBackupsListByResourceGroupLocationOptionalParams)

Lists the long term retention backups for a given location.

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

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

options

LongTermRetentionBackupsListByResourceGroupLocationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByResourceGroupServer(string, string, string, LongTermRetentionBackupsListByResourceGroupServerOptionalParams)

Lists the long term retention backups for a given server.

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

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

options

LongTermRetentionBackupsListByResourceGroupServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>

listByServer(string, string, LongTermRetentionBackupsListByServerOptionalParams)

Lists the long term retention backups for a given server.

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

Parameters

locationName

string

The location of the database

longTermRetentionServerName

string

The name of the server

options

LongTermRetentionBackupsListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LongTermRetentionBackup, LongTermRetentionBackup[], PageSettings>