Package version:

Interface LongTermRetentionManagedInstanceBackups

Interface representing a LongTermRetentionManagedInstanceBackups.

Hierarchy

LongTermRetentionManagedInstanceBackups

Index

Methods

beginDelete beginDeleteAndWait beginDeleteByResourceGroup beginDeleteByResourceGroupAndWait get getByResourceGroup listByDatabase listByInstance listByLocation listByResourceGroupDatabase listByResourceGroupInstance listByResourceGroupLocation

Methods

beginDelete

beginDelete(locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a long term retention backup.
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.
- Optional options: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:128

beginDeleteAndWait

beginDeleteAndWait(locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams): Promise<void>
Deletes a long term retention backup.
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.
- Optional options: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:143

beginDeleteByResourceGroup

beginDeleteByResourceGroup(resourceGroupName: string, locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams): 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
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the managed database.
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:178

beginDeleteByResourceGroupAndWait

beginDeleteByResourceGroupAndWait(resourceGroupName: string, locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams): 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
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the managed database.
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:196

get

get(locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsGetOptionalParams): Promise<ManagedInstanceLongTermRetentionBackup>
Gets a long term retention backup for a managed database.
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.
- Optional options: LongTermRetentionManagedInstanceBackupsGetOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstanceLongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:113

getByResourceGroup

getByResourceGroup(resourceGroupName: string, locationName: string, managedInstanceName: string, databaseName: string, backupName: string, options?: LongTermRetentionManagedInstanceBackupsGetByResourceGroupOptionalParams): Promise<ManagedInstanceLongTermRetentionBackup>
Gets a long term retention backup for a managed 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the managed database.
- backupName: string
  
  The backup name.
- Optional options: LongTermRetentionManagedInstanceBackupsGetByResourceGroupOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstanceLongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:160

listByDatabase

listByDatabase(locationName: string, managedInstanceName: string, databaseName: string, options?: LongTermRetentionManagedInstanceBackupsListByDatabaseOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
Lists all long term retention backups for a managed database.
Parameters
- locationName: string
  
  The location of the database.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the managed database.
- Optional options: LongTermRetentionManagedInstanceBackupsListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:37

listByInstance

listByInstance(locationName: string, managedInstanceName: string, options?: LongTermRetentionManagedInstanceBackupsListByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
Lists the long term retention backups for a given managed instance.
Parameters
- locationName: string
  
  The location of the database
- managedInstanceName: string
  
  The name of the managed instance.
- Optional options: LongTermRetentionManagedInstanceBackupsListByInstanceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:49

listByLocation

listByLocation(locationName: string, options?: LongTermRetentionManagedInstanceBackupsListByLocationOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
Lists the long term retention backups for managed databases in a given location.
Parameters
- locationName: string
  
  The location of the database.
- Optional options: LongTermRetentionManagedInstanceBackupsListByLocationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:59

listByResourceGroupDatabase

listByResourceGroupDatabase(resourceGroupName: string, locationName: string, managedInstanceName: string, databaseName: string, options?: LongTermRetentionManagedInstanceBackupsListByResourceGroupDatabaseOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
Lists all long term retention backups for a managed 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
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the managed database.
- Optional options: LongTermRetentionManagedInstanceBackupsListByResourceGroupDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:72

listByResourceGroupInstance

listByResourceGroupInstance(resourceGroupName: string, locationName: string, managedInstanceName: string, options?: LongTermRetentionManagedInstanceBackupsListByResourceGroupInstanceOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
Lists the long term retention backups for a given managed instance.
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.
- Optional options: LongTermRetentionManagedInstanceBackupsListByResourceGroupInstanceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:87

listByResourceGroupLocation

listByResourceGroupLocation(resourceGroupName: string, locationName: string, options?: LongTermRetentionManagedInstanceBackupsListByResourceGroupLocationOptionalParams): PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
Lists the long term retention backups for managed databases in 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: LongTermRetentionManagedInstanceBackupsListByResourceGroupLocationOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>
- Defined in operationsInterfaces/longTermRetentionManagedInstanceBackups.ts:100

Interface LongTermRetentionManagedInstanceBackups

Hierarchy

Index

Methods

Methods

beginDelete

Parameters

locationName: string

managedInstanceName: string

databaseName: string

backupName: string

Optional options: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

locationName: string

managedInstanceName: string

databaseName: string

backupName: string

Optional options: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams

Returns Promise<void>

beginDeleteByResourceGroup

Parameters

resourceGroupName: string

locationName: string

managedInstanceName: string

databaseName: string

backupName: string

Optional options: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams

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

beginDeleteByResourceGroupAndWait

Parameters

resourceGroupName: string

locationName: string

managedInstanceName: string

databaseName: string

backupName: string

Optional options: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams

Returns Promise<void>

get

Parameters

locationName: string

managedInstanceName: string

databaseName: string

backupName: string

Optional options: LongTermRetentionManagedInstanceBackupsGetOptionalParams

Returns Promise<ManagedInstanceLongTermRetentionBackup>

getByResourceGroup

Parameters

resourceGroupName: string

locationName: string

managedInstanceName: string

databaseName: string

backupName: string

Optional options: LongTermRetentionManagedInstanceBackupsGetByResourceGroupOptionalParams

Returns Promise<ManagedInstanceLongTermRetentionBackup>

listByDatabase

Parameters

locationName: string

managedInstanceName: string

databaseName: string

Optional options: LongTermRetentionManagedInstanceBackupsListByDatabaseOptionalParams

Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>

listByInstance

Parameters

locationName: string

managedInstanceName: string

Optional options: LongTermRetentionManagedInstanceBackupsListByInstanceOptionalParams

Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>

listByLocation

Parameters

locationName: string

Optional options: LongTermRetentionManagedInstanceBackupsListByLocationOptionalParams

Returns PagedAsyncIterableIterator<ManagedInstanceLongTermRetentionBackup>

listByResourceGroupDatabase

Parameters

resourceGroupName: string

locationName: string

managedInstanceName: string

databaseName: string

`Optional` options: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsDeleteOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsDeleteByResourceGroupOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsGetOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsGetByResourceGroupOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsListByDatabaseOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsListByInstanceOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsListByLocationOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsListByResourceGroupDatabaseOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsListByResourceGroupInstanceOptionalParams

`Optional` options: LongTermRetentionManagedInstanceBackupsListByResourceGroupLocationOptionalParams