ManagedDatabases interface

Package:

@azure/arm-sql

Interface representing a ManagedDatabases.

Methods

beginCancelMove(string, string, string, ManagedDatabaseMoveDefinition, ManagedDatabasesCancelMoveOptionalParams)	Cancels a managed database move operation.
beginCancelMoveAndWait(string, string, string, ManagedDatabaseMoveDefinition, ManagedDatabasesCancelMoveOptionalParams)	Cancels a managed database move operation.
beginCompleteMove(string, string, string, ManagedDatabaseMoveDefinition, ManagedDatabasesCompleteMoveOptionalParams)	Completes a managed database move operation.
beginCompleteMoveAndWait(string, string, string, ManagedDatabaseMoveDefinition, ManagedDatabasesCompleteMoveOptionalParams)	Completes a managed database move operation.
beginCompleteRestore(string, string, string, CompleteDatabaseRestoreDefinition, ManagedDatabasesCompleteRestoreOptionalParams)	Completes the restore operation on a managed database.
beginCompleteRestoreAndWait(string, string, string, CompleteDatabaseRestoreDefinition, ManagedDatabasesCompleteRestoreOptionalParams)	Completes the restore operation on a managed database.
beginCreateOrUpdate(string, string, string, ManagedDatabase, ManagedDatabasesCreateOrUpdateOptionalParams)	Creates a new database or updates an existing database.
beginCreateOrUpdateAndWait(string, string, string, ManagedDatabase, ManagedDatabasesCreateOrUpdateOptionalParams)	Creates a new database or updates an existing database.
beginDelete(string, string, string, ManagedDatabasesDeleteOptionalParams)	Deletes a managed database.
beginDeleteAndWait(string, string, string, ManagedDatabasesDeleteOptionalParams)	Deletes a managed database.
beginStartMove(string, string, string, ManagedDatabaseStartMoveDefinition, ManagedDatabasesStartMoveOptionalParams)	Starts a managed database move operation.
beginStartMoveAndWait(string, string, string, ManagedDatabaseStartMoveDefinition, ManagedDatabasesStartMoveOptionalParams)	Starts a managed database move operation.
beginUpdate(string, string, string, ManagedDatabaseUpdate, ManagedDatabasesUpdateOptionalParams)	Updates an existing database.
beginUpdateAndWait(string, string, string, ManagedDatabaseUpdate, ManagedDatabasesUpdateOptionalParams)	Updates an existing database.
get(string, string, string, ManagedDatabasesGetOptionalParams)	Gets a managed database.
listByInstance(string, string, ManagedDatabasesListByInstanceOptionalParams)	Gets a list of managed databases.
listInaccessibleByInstance(string, string, ManagedDatabasesListInaccessibleByInstanceOptionalParams)	Gets a list of inaccessible managed databases in a managed instance

Method Details

beginCancelMove(string, string, string, ManagedDatabaseMoveDefinition, ManagedDatabasesCancelMoveOptionalParams)

Cancels a managed database move operation.

function beginCancelMove(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseMoveDefinition, options?: ManagedDatabasesCancelMoveOptionalParams): 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.

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.

options

ManagedDatabasesCancelMoveOptionalParams

The options parameters.

Returns

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

beginCancelMoveAndWait(string, string, string, ManagedDatabaseMoveDefinition, ManagedDatabasesCancelMoveOptionalParams)

Cancels a managed database move operation.

function beginCancelMoveAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseMoveDefinition, options?: ManagedDatabasesCancelMoveOptionalParams): 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.

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.

options

ManagedDatabasesCancelMoveOptionalParams

The options parameters.

Returns

Promise<void>

beginCompleteMove(string, string, string, ManagedDatabaseMoveDefinition, ManagedDatabasesCompleteMoveOptionalParams)

Completes a managed database move operation.

function beginCompleteMove(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseMoveDefinition, options?: ManagedDatabasesCompleteMoveOptionalParams): 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.

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.

options

ManagedDatabasesCompleteMoveOptionalParams

The options parameters.

Returns

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

beginCompleteMoveAndWait(string, string, string, ManagedDatabaseMoveDefinition, ManagedDatabasesCompleteMoveOptionalParams)

Completes a managed database move operation.

function beginCompleteMoveAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseMoveDefinition, options?: ManagedDatabasesCompleteMoveOptionalParams): 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.

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.

options

ManagedDatabasesCompleteMoveOptionalParams

The options parameters.

Returns

Promise<void>

beginCompleteRestore(string, string, string, CompleteDatabaseRestoreDefinition, ManagedDatabasesCompleteRestoreOptionalParams)

Completes the restore operation on a managed database.

function beginCompleteRestore(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: CompleteDatabaseRestoreDefinition, options?: ManagedDatabasesCompleteRestoreOptionalParams): 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.

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.

options

ManagedDatabasesCompleteRestoreOptionalParams

The options parameters.

Returns

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

beginCompleteRestoreAndWait(string, string, string, CompleteDatabaseRestoreDefinition, ManagedDatabasesCompleteRestoreOptionalParams)

Completes the restore operation on a managed database.

function beginCompleteRestoreAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: CompleteDatabaseRestoreDefinition, options?: ManagedDatabasesCompleteRestoreOptionalParams): 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.

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.

options

ManagedDatabasesCompleteRestoreOptionalParams

The options parameters.

Returns

Promise<void>

beginCreateOrUpdate(string, string, string, ManagedDatabase, ManagedDatabasesCreateOrUpdateOptionalParams)

Creates a new database or updates an existing database.

function beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabase, options?: ManagedDatabasesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedDatabase>, ManagedDatabase>>

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.

options

ManagedDatabasesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, ManagedDatabase, ManagedDatabasesCreateOrUpdateOptionalParams)

Creates a new database or updates an existing database.

function beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabase, options?: ManagedDatabasesCreateOrUpdateOptionalParams): Promise<ManagedDatabase>

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.

options

ManagedDatabasesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedDatabase>

beginDelete(string, string, string, ManagedDatabasesDeleteOptionalParams)

Deletes a managed database.

function beginDelete(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedDatabasesDeleteOptionalParams): 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.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the database.

options

ManagedDatabasesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ManagedDatabasesDeleteOptionalParams)

Deletes a managed database.

function beginDeleteAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedDatabasesDeleteOptionalParams): 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.

managedInstanceName

string

The name of the managed instance.

databaseName

string

The name of the database.

options

ManagedDatabasesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginStartMove(string, string, string, ManagedDatabaseStartMoveDefinition, ManagedDatabasesStartMoveOptionalParams)

Starts a managed database move operation.

function beginStartMove(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseStartMoveDefinition, options?: ManagedDatabasesStartMoveOptionalParams): 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.

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.

options

ManagedDatabasesStartMoveOptionalParams

The options parameters.

Returns

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

beginStartMoveAndWait(string, string, string, ManagedDatabaseStartMoveDefinition, ManagedDatabasesStartMoveOptionalParams)

Starts a managed database move operation.

function beginStartMoveAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseStartMoveDefinition, options?: ManagedDatabasesStartMoveOptionalParams): 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.

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.

options

ManagedDatabasesStartMoveOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, ManagedDatabaseUpdate, ManagedDatabasesUpdateOptionalParams)

Updates an existing database.

function beginUpdate(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseUpdate, options?: ManagedDatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedDatabase>, ManagedDatabase>>

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.

options

ManagedDatabasesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, ManagedDatabaseUpdate, ManagedDatabasesUpdateOptionalParams)

Updates an existing database.

function beginUpdateAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, parameters: ManagedDatabaseUpdate, options?: ManagedDatabasesUpdateOptionalParams): Promise<ManagedDatabase>

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.

options

ManagedDatabasesUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedDatabase>

get(string, string, string, ManagedDatabasesGetOptionalParams)

Gets a managed database.

function get(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedDatabasesGetOptionalParams): Promise<ManagedDatabase>

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.

options

ManagedDatabasesGetOptionalParams

The options parameters.

Returns

Promise<ManagedDatabase>

listByInstance(string, string, ManagedDatabasesListByInstanceOptionalParams)

Gets a list of managed databases.

function listByInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedDatabasesListByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedDatabase, ManagedDatabase[], 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.

managedInstanceName

string

The name of the managed instance.

options

ManagedDatabasesListByInstanceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedDatabase, ManagedDatabase[], PageSettings>

listInaccessibleByInstance(string, string, ManagedDatabasesListInaccessibleByInstanceOptionalParams)

Gets a list of inaccessible managed databases in a managed instance

function listInaccessibleByInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedDatabasesListInaccessibleByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedDatabase, ManagedDatabase[], 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.

managedInstanceName

string

The name of the managed instance.

options

ManagedDatabasesListInaccessibleByInstanceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedDatabase, ManagedDatabase[], PageSettings>