Package version:

Interface ManagedDatabases

Interface representing a ManagedDatabases.

Hierarchy

ManagedDatabases

Index

Methods

beginCancelMove beginCancelMoveAndWait beginCompleteMove beginCompleteMoveAndWait beginCompleteRestore beginCompleteRestoreAndWait beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginStartMove beginStartMoveAndWait beginUpdate beginUpdateAndWait get listByInstance listInaccessibleByInstance

Methods

beginCancelMove

beginCancelMove(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseMoveDefinition, options?: ManagedDatabasesCancelMoveOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Cancels a managed database move operation.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabaseMoveDefinition
  
  Parameters of the cancel managed database move operation.
- Optional options: ManagedDatabasesCancelMoveOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedDatabases.ts:184

beginCancelMoveAndWait

beginCancelMoveAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseMoveDefinition, options?: ManagedDatabasesCancelMoveOptionalParams): Promise<void>
Cancels a managed database move operation.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabaseMoveDefinition
  
  Parameters of the cancel managed database move operation.
- Optional options: ManagedDatabasesCancelMoveOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedDatabases.ts:200

beginCompleteMove

beginCompleteMove(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseMoveDefinition, options?: ManagedDatabasesCompleteMoveOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Completes a managed database move operation.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabaseMoveDefinition
  
  Parameters of the complete managed database move operation.
- Optional options: ManagedDatabasesCompleteMoveOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedDatabases.ts:216

beginCompleteMoveAndWait

beginCompleteMoveAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseMoveDefinition, options?: ManagedDatabasesCompleteMoveOptionalParams): Promise<void>
Completes a managed database move operation.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabaseMoveDefinition
  
  Parameters of the complete managed database move operation.
- Optional options: ManagedDatabasesCompleteMoveOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedDatabases.ts:232

beginCompleteRestore

beginCompleteRestore(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: CompleteDatabaseRestoreDefinition, options?: ManagedDatabasesCompleteRestoreOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Completes the restore operation on 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: CompleteDatabaseRestoreDefinition
  
  The definition for completing the restore of this managed database.
- Optional options: ManagedDatabasesCompleteRestoreOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedDatabases.ts:248

beginCompleteRestoreAndWait

beginCompleteRestoreAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: CompleteDatabaseRestoreDefinition, options?: ManagedDatabasesCompleteRestoreOptionalParams): Promise<void>
Completes the restore operation on 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: CompleteDatabaseRestoreDefinition
  
  The definition for completing the restore of this managed database.
- Optional options: ManagedDatabasesCompleteRestoreOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedDatabases.ts:264

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabase, options?: ManagedDatabasesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedDatabase>, ManagedDatabase>>
Creates a new database or updates an existing 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabase
  
  The requested database resource state.
- Optional options: ManagedDatabasesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedDatabase>, ManagedDatabase>>
- Defined in operationsInterfaces/managedDatabases.ts:82

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabase, options?: ManagedDatabasesCreateOrUpdateOptionalParams): Promise<ManagedDatabase>
Creates a new database or updates an existing 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabase
  
  The requested database resource state.
- Optional options: ManagedDatabasesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedDatabase>
- Defined in operationsInterfaces/managedDatabases.ts:103

beginDelete

beginDelete(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedDatabasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- Optional options: ManagedDatabasesDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedDatabases.ts:118

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedDatabasesDeleteOptionalParams): Promise<void>
Deletes 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- Optional options: ManagedDatabasesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedDatabases.ts:132

beginStartMove

beginStartMove(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseStartMoveDefinition, options?: ManagedDatabasesStartMoveOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Starts a managed database move operation.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabaseStartMoveDefinition
  
  Parameters of the start managed database move operation.
- Optional options: ManagedDatabasesStartMoveOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedDatabases.ts:280

beginStartMoveAndWait

beginStartMoveAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseStartMoveDefinition, options?: ManagedDatabasesStartMoveOptionalParams): Promise<void>
Starts a managed database move operation.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabaseStartMoveDefinition
  
  Parameters of the start managed database move operation.
- Optional options: ManagedDatabasesStartMoveOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedDatabases.ts:296

beginUpdate

beginUpdate(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseUpdate, options?: ManagedDatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedDatabase>, ManagedDatabase>>
Updates an existing 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabaseUpdate
  
  The requested database resource state.
- Optional options: ManagedDatabasesUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedDatabase>, ManagedDatabase>>
- Defined in operationsInterfaces/managedDatabases.ts:147

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseUpdate, options?: ManagedDatabasesUpdateOptionalParams): Promise<ManagedDatabase>
Updates an existing 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- parameters: ManagedDatabaseUpdate
  
  The requested database resource state.
- Optional options: ManagedDatabasesUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedDatabase>
- Defined in operationsInterfaces/managedDatabases.ts:168

get

get(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedDatabasesGetOptionalParams): Promise<ManagedDatabase>
Gets 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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- Optional options: ManagedDatabasesGetOptionalParams
  
  The options parameters.
Returns Promise<ManagedDatabase>
- Defined in operationsInterfaces/managedDatabases.ts:67

listByInstance

listByInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedDatabasesListByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedDatabase>
Gets a list of managed databases.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- Optional options: ManagedDatabasesListByInstanceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedDatabase>
- Defined in operationsInterfaces/managedDatabases.ts:42

listInaccessibleByInstance

listInaccessibleByInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedDatabasesListInaccessibleByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedDatabase>
Gets a list of inaccessible managed databases in a 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.
- managedInstanceName: string
  
  The name of the managed instance.
- Optional options: ManagedDatabasesListInaccessibleByInstanceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedDatabase>
- Defined in operationsInterfaces/managedDatabases.ts:54

Interface ManagedDatabases

Hierarchy

Index

Methods

Methods

beginCancelMove

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

parameters: ManagedDatabaseMoveDefinition

Optional options: ManagedDatabasesCancelMoveOptionalParams

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

beginCancelMoveAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

parameters: ManagedDatabaseMoveDefinition

Optional options: ManagedDatabasesCancelMoveOptionalParams

Returns Promise<void>

beginCompleteMove

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

parameters: ManagedDatabaseMoveDefinition

Optional options: ManagedDatabasesCompleteMoveOptionalParams

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

beginCompleteMoveAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

parameters: ManagedDatabaseMoveDefinition

Optional options: ManagedDatabasesCompleteMoveOptionalParams

Returns Promise<void>

beginCompleteRestore

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

parameters: CompleteDatabaseRestoreDefinition

Optional options: ManagedDatabasesCompleteRestoreOptionalParams

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

beginCompleteRestoreAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

parameters: CompleteDatabaseRestoreDefinition

Optional options: ManagedDatabasesCompleteRestoreOptionalParams

Returns Promise<void>

beginCreateOrUpdate

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

parameters: ManagedDatabase

Optional options: ManagedDatabasesCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ManagedDatabase>, ManagedDatabase>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

parameters: ManagedDatabase

Optional options: ManagedDatabasesCreateOrUpdateOptionalParams

Returns Promise<ManagedDatabase>

beginDelete

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

Optional options: ManagedDatabasesDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

`Optional` options: ManagedDatabasesCancelMoveOptionalParams

`Optional` options: ManagedDatabasesCancelMoveOptionalParams

`Optional` options: ManagedDatabasesCompleteMoveOptionalParams

`Optional` options: ManagedDatabasesCompleteMoveOptionalParams

`Optional` options: ManagedDatabasesCompleteRestoreOptionalParams

`Optional` options: ManagedDatabasesCompleteRestoreOptionalParams

`Optional` options: ManagedDatabasesCreateOrUpdateOptionalParams

`Optional` options: ManagedDatabasesCreateOrUpdateOptionalParams

`Optional` options: ManagedDatabasesDeleteOptionalParams

`Optional` options: ManagedDatabasesDeleteOptionalParams

`Optional` options: ManagedDatabasesStartMoveOptionalParams

`Optional` options: ManagedDatabasesStartMoveOptionalParams

`Optional` options: ManagedDatabasesUpdateOptionalParams

`Optional` options: ManagedDatabasesUpdateOptionalParams

`Optional` options: ManagedDatabasesGetOptionalParams

`Optional` options: ManagedDatabasesListByInstanceOptionalParams

`Optional` options: ManagedDatabasesListInaccessibleByInstanceOptionalParams