LongTermRetentionManagedInstanceBackups interface

Package:

@azure/arm-sql

Interface representing a LongTermRetentionManagedInstanceBackups.

Methods

beginDelete(string, string, string, string, LongTermRetentionManagedInstanceBackupsDeleteOptionalParams)	Deletes a long term retention backup.
beginDeleteAndWait(string, string, string, string, LongTermRetentionManagedInstanceBackupsDeleteOptionalParams)	Deletes a long term retention backup.
beginDeleteByResourceGroup(string, string, string, string, string, LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams)	Deletes a long term retention backup.
beginDeleteByResourceGroupAndWait(string, string, string, string, string, LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams)	Deletes a long term retention backup.
get(string, string, string, string, LongTermRetentionManagedInstanceBackupsGetOptionalParams)	Gets a long term retention backup for a managed database.
getByResourceGroup(string, string, string, string, string, LongTermRetentionManagedInstanceBackupsGetByResourceGroupOptionalParams)	Gets a long term retention backup for a managed database.
listByDatabase(string, string, string, LongTermRetentionManagedInstanceBackupsListByDatabaseOptionalParams)	Lists all long term retention backups for a managed database.
listByInstance(string, string, LongTermRetentionManagedInstanceBackupsListByInstanceOptionalParams)	Lists the long term retention backups for a given managed instance.
listByLocation(string, LongTermRetentionManagedInstanceBackupsListByLocationOptionalParams)	Lists the long term retention backups for managed databases in a given location.
listByResourceGroupDatabase(string, string, string, string, LongTermRetentionManagedInstanceBackupsListByResourceGroupDatabaseOptionalParams)	Lists all long term retention backups for a managed database.
listByResourceGroupInstance(string, string, string, LongTermRetentionManagedInstanceBackupsListByResourceGroupInstanceOptionalParams)	Lists the long term retention backups for a given managed instance.
listByResourceGroupLocation(string, string, LongTermRetentionManagedInstanceBackupsListByResourceGroupLocationOptionalParams)	Lists the long term retention backups for managed databases in a given location.

Method Details

beginDelete(string, string, string, string, LongTermRetentionManagedInstanceBackupsDeleteOptionalParams)

Deletes a long term retention backup.

function beginDelete(locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

locationName

string

The location of the database.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the managed database.

backupName

string

The backup name.

options

LongTermRetentionManagedInstanceBackupsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, LongTermRetentionManagedInstanceBackupsDeleteOptionalParams)

Deletes a long term retention backup.

function beginDeleteAndWait(locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams): Promise<void>

Parameters

locationName

string

The location of the database.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the managed database.

backupName

string

The backup name.

options

LongTermRetentionManagedInstanceBackupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginDeleteByResourceGroup(string, string, string, string, string, LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams)

Deletes a long term retention backup.

function beginDeleteByResourceGroup(resourceGroupName: string, locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams): 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

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the managed database.

backupName

string

The backup name.

options

LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams

The options parameters.

Returns

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

beginDeleteByResourceGroupAndWait(string, string, string, string, string, LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams)

Deletes a long term retention backup.

function beginDeleteByResourceGroupAndWait(resourceGroupName: string, locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams): 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

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the managed database.

backupName

string

The backup name.

options

LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, LongTermRetentionManagedInstanceBackupsGetOptionalParams)

Gets a long term retention backup for a managed database.

function get(locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsGetOptionalParams): Promise<ManagedInstanceLongTermRetentionBackup>

Parameters

locationName

string

The location of the database.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the managed database.

backupName

string

The backup name.

options

LongTermRetentionManagedInstanceBackupsGetOptionalParams

The options parameters.

Returns

Promise<ManagedInstanceLongTermRetentionBackup>

getByResourceGroup(string, string, string, string, string, LongTermRetentionManagedInstanceBackupsGetByResourceGroupOptionalParams)

Gets a long term retention backup for a managed database.

function getByResourceGroup(resourceGroupName: string, locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsGetByResourceGroupOptionalParams): Promise<ManagedInstanceLongTermRetentionBackup>

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.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the managed database.

backupName

string

The backup name.

options

LongTermRetentionManagedInstanceBackupsGetByResourceGroupOptionalParams

The options parameters.

Returns

Promise<ManagedInstanceLongTermRetentionBackup>

listByDatabase(string, string, string, LongTermRetentionManagedInstanceBackupsListByDatabaseOptionalParams)

Lists all long term retention backups for a managed database.

function listByDatabase(locationName: string, managedInstanceName: string, databaseName: string, options?: LongTermRetentionManagedInstanceBackupsListByDatabaseOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], PageSettings>

Parameters

locationName

string

The location of the database.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the managed database.

options

LongTermRetentionManagedInstanceBackupsListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], PageSettings>

listByInstance(string, string, LongTermRetentionManagedInstanceBackupsListByInstanceOptionalParams)

Lists the long term retention backups for a given managed instance.

function listByInstance(locationName: string, managedInstanceName: string, options?: LongTermRetentionManagedInstanceBackupsListByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], PageSettings>

Parameters

locationName

string

The location of the database

managedInstanceName

string

The name of the managed instance.

options

LongTermRetentionManagedInstanceBackupsListByInstanceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], PageSettings>

listByLocation(string, LongTermRetentionManagedInstanceBackupsListByLocationOptionalParams)

Lists the long term retention backups for managed databases in a given location.

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

Parameters

locationName

string

The location of the database.

options

LongTermRetentionManagedInstanceBackupsListByLocationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], PageSettings>

listByResourceGroupDatabase(string, string, string, string, LongTermRetentionManagedInstanceBackupsListByResourceGroupDatabaseOptionalParams)

Lists all long term retention backups for a managed database.

function listByResourceGroupDatabase(resourceGroupName: string, locationName: string, managedInstanceName: string, databaseName: string, options?: LongTermRetentionManagedInstanceBackupsListByResourceGroupDatabaseOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], 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

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the managed database.

options

LongTermRetentionManagedInstanceBackupsListByResourceGroupDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], PageSettings>

listByResourceGroupInstance(string, string, string, LongTermRetentionManagedInstanceBackupsListByResourceGroupInstanceOptionalParams)

Lists the long term retention backups for a given managed instance.

function listByResourceGroupInstance(resourceGroupName: string, locationName: string, managedInstanceName: string, options?: LongTermRetentionManagedInstanceBackupsListByResourceGroupInstanceOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], 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.

managedInstanceName

string

The name of the managed instance.

options

LongTermRetentionManagedInstanceBackupsListByResourceGroupInstanceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], PageSettings>

listByResourceGroupLocation(string, string, LongTermRetentionManagedInstanceBackupsListByResourceGroupLocationOptionalParams)

Lists the long term retention backups for managed databases in a given location.

function listByResourceGroupLocation(resourceGroupName: string, locationName: string, options?: LongTermRetentionManagedInstanceBackupsListByResourceGroupLocationOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], 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

LongTermRetentionManagedInstanceBackupsListByResourceGroupLocationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup, ManagedInstanceLongTermRetentionBackup[], PageSettings>