DatabasesOperations interface

Package:

@azure/arm-sql

Interface representing a Databases operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginExport
beginExportAndWait
beginFailover
beginFailoverAndWait
beginImport
beginImportAndWait
beginPause
beginPauseAndWait
beginResume
beginResumeAndWait
beginUpdate
beginUpdateAndWait
beginUpgradeDataWarehouse
beginUpgradeDataWarehouseAndWait
createOrUpdate	Creates a new database or updates an existing database.
delete	Deletes the database.
export	Exports a database.
failover	Failovers a database.
get	Gets a database.
import	Imports a bacpac into a new database.
listByElasticPool	Gets a list of databases in an elastic pool.
listByServer	Gets a list of databases.
listInaccessibleByServer	Gets a list of inaccessible databases in a logical server
pause	Pauses a database.
rename	Renames a database.
resume	Resumes a database.
update	Updates an existing database.
upgradeDataWarehouse	Upgrades a data warehouse.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams) => Promise<Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams) => Promise<Database>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => Promise<void>

beginExport

Warning

This API is now deprecated.

use export instead

beginExport: (resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams) => Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams) => Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>

beginExportAndWait

Warning

This API is now deprecated.

use export instead

beginExportAndWait: (resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams) => Promise<ImportExportOperationResult>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams) => Promise<ImportExportOperationResult>

beginFailover

Warning

This API is now deprecated.

use failover instead

beginFailover: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginFailoverAndWait

Warning

This API is now deprecated.

use failover instead

beginFailoverAndWait: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams) => Promise<void>

beginImport

Warning

This API is now deprecated.

use import instead

beginImport: (resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams) => Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams) => Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>

beginImportAndWait

Warning

This API is now deprecated.

use import instead

beginImportAndWait: (resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams) => Promise<ImportExportOperationResult>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams) => Promise<ImportExportOperationResult>

beginPause

Warning

This API is now deprecated.

use pause instead

beginPause: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

beginPauseAndWait

Warning

This API is now deprecated.

use pause instead

beginPauseAndWait: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams) => Promise<Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams) => Promise<Database>

beginResume

Warning

This API is now deprecated.

use resume instead

beginResume: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

beginResumeAndWait

Warning

This API is now deprecated.

use resume instead

beginResumeAndWait: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams) => Promise<Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams) => Promise<Database>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Database>, Database>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => Promise<Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => Promise<Database>

beginUpgradeDataWarehouse

Warning

This API is now deprecated.

use upgradeDataWarehouse instead

beginUpgradeDataWarehouse: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginUpgradeDataWarehouseAndWait

Warning

This API is now deprecated.

use upgradeDataWarehouse instead

beginUpgradeDataWarehouseAndWait: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams) => Promise<void>

createOrUpdate

Creates a new database or updates an existing database.

createOrUpdate: (resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Database>, Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams) => PollerLike<OperationState<Database>, Database>

delete

Deletes the database.

delete: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

export

Exports a database.

export: (resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams) => PollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams) => PollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>

failover

Failovers a database.

failover: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a database.

get: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesGetOptionalParams) => Promise<Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesGetOptionalParams) => Promise<Database>

import

Imports a bacpac into a new database.

import: (resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams) => PollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams) => PollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>

listByElasticPool

Gets a list of databases in an elastic pool.

listByElasticPool: (resourceGroupName: string, serverName: string, elasticPoolName: string, options?: DatabasesListByElasticPoolOptionalParams) => PagedAsyncIterableIterator<Database, Database[], PageSettings>

Property Value

(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: DatabasesListByElasticPoolOptionalParams) => PagedAsyncIterableIterator<Database, Database[], PageSettings>

listByServer

Gets a list of databases.

listByServer: (resourceGroupName: string, serverName: string, options?: DatabasesListByServerOptionalParams) => PagedAsyncIterableIterator<Database, Database[], PageSettings>

Property Value

(resourceGroupName: string, serverName: string, options?: DatabasesListByServerOptionalParams) => PagedAsyncIterableIterator<Database, Database[], PageSettings>

listInaccessibleByServer

Gets a list of inaccessible databases in a logical server

listInaccessibleByServer: (resourceGroupName: string, serverName: string, options?: DatabasesListInaccessibleByServerOptionalParams) => PagedAsyncIterableIterator<Database, Database[], PageSettings>

Property Value

(resourceGroupName: string, serverName: string, options?: DatabasesListInaccessibleByServerOptionalParams) => PagedAsyncIterableIterator<Database, Database[], PageSettings>

pause

Pauses a database.

pause: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams) => PollerLike<OperationState<Database>, Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams) => PollerLike<OperationState<Database>, Database>

rename

Renames a database.

rename: (resourceGroupName: string, serverName: string, databaseName: string, parameters: ResourceMoveDefinition, options?: DatabasesRenameOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: ResourceMoveDefinition, options?: DatabasesRenameOptionalParams) => Promise<void>

resume

Resumes a database.

resume: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams) => PollerLike<OperationState<Database>, Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams) => PollerLike<OperationState<Database>, Database>

update

Updates an existing database.

update: (resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => PollerLike<OperationState<Database>, Database>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams) => PollerLike<OperationState<Database>, Database>

upgradeDataWarehouse

Upgrades a data warehouse.

upgradeDataWarehouse: (resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams) => PollerLike<OperationState<void>, void>