Databases interface
Interface representing a Databases.
Methods
Method Details
beginCreateOrUpdate(string, string, string, Database, DatabasesCreateOrUpdateOptionalParams)
Creates a new database or updates an existing database.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- parameters
- Database
The requested database resource state.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginCreateOrUpdateAndWait(string, string, string, Database, DatabasesCreateOrUpdateOptionalParams)
Creates a new database or updates an existing database.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams): Promise<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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- parameters
- Database
The requested database resource state.
The options parameters.
Returns
Promise<Database>
beginDelete(string, string, string, DatabasesDeleteOptionalParams)
Deletes the database.
function beginDelete(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- options
- DatabasesDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, DatabasesDeleteOptionalParams)
Deletes the database.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- options
- DatabasesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginExport(string, string, string, ExportDatabaseDefinition, DatabasesExportOptionalParams)
Exports a database.
function beginExport(resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams): Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- parameters
- ExportDatabaseDefinition
The database export request parameters.
- options
- DatabasesExportOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>
beginExportAndWait(string, string, string, ExportDatabaseDefinition, DatabasesExportOptionalParams)
Exports a database.
function beginExportAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams): Promise<ImportExportOperationResult>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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- parameters
- ExportDatabaseDefinition
The database export request parameters.
- options
- DatabasesExportOptionalParams
The options parameters.
Returns
Promise<ImportExportOperationResult>
beginFailover(string, string, string, DatabasesFailoverOptionalParams)
Failovers a database.
function beginFailover(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams): 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to failover.
- options
- DatabasesFailoverOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginFailoverAndWait(string, string, string, DatabasesFailoverOptionalParams)
Failovers a database.
function beginFailoverAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams): 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to failover.
- options
- DatabasesFailoverOptionalParams
The options parameters.
Returns
Promise<void>
beginImport(string, string, string, ImportExistingDatabaseDefinition, DatabasesImportOptionalParams)
Imports a bacpac into a new database.
function beginImport(resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams): Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- parameters
- ImportExistingDatabaseDefinition
The database import request parameters.
- options
- DatabasesImportOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>
beginImportAndWait(string, string, string, ImportExistingDatabaseDefinition, DatabasesImportOptionalParams)
Imports a bacpac into a new database.
function beginImportAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams): Promise<ImportExportOperationResult>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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- parameters
- ImportExistingDatabaseDefinition
The database import request parameters.
- options
- DatabasesImportOptionalParams
The options parameters.
Returns
Promise<ImportExportOperationResult>
beginPause(string, string, string, DatabasesPauseOptionalParams)
Pauses a database.
function beginPause(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams): Promise<SimplePollerLike<OperationState<Database>, 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to be paused.
- options
- DatabasesPauseOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginPauseAndWait(string, string, string, DatabasesPauseOptionalParams)
Pauses a database.
function beginPauseAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams): Promise<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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to be paused.
- options
- DatabasesPauseOptionalParams
The options parameters.
Returns
Promise<Database>
beginResume(string, string, string, DatabasesResumeOptionalParams)
Resumes a database.
function beginResume(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams): Promise<SimplePollerLike<OperationState<Database>, 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to be resumed.
- options
- DatabasesResumeOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginResumeAndWait(string, string, string, DatabasesResumeOptionalParams)
Resumes a database.
function beginResumeAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams): Promise<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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to be resumed.
- options
- DatabasesResumeOptionalParams
The options parameters.
Returns
Promise<Database>
beginUpdate(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
Updates an existing database.
function beginUpdate(resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- parameters
- DatabaseUpdate
The requested database resource state.
- options
- DatabasesUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Database>, Database>>
beginUpdateAndWait(string, string, string, DatabaseUpdate, DatabasesUpdateOptionalParams)
Updates an existing database.
function beginUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- parameters
- DatabaseUpdate
The requested database resource state.
- options
- DatabasesUpdateOptionalParams
The options parameters.
Returns
Promise<Database>
beginUpgradeDataWarehouse(string, string, string, DatabasesUpgradeDataWarehouseOptionalParams)
Upgrades a data warehouse.
function beginUpgradeDataWarehouse(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams): 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to be upgraded.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginUpgradeDataWarehouseAndWait(string, string, string, DatabasesUpgradeDataWarehouseOptionalParams)
Upgrades a data warehouse.
function beginUpgradeDataWarehouseAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams): 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to be upgraded.
The options parameters.
Returns
Promise<void>
get(string, string, string, DatabasesGetOptionalParams)
Gets a database.
function get(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- options
- DatabasesGetOptionalParams
The options parameters.
Returns
Promise<Database>
listByElasticPool(string, string, string, DatabasesListByElasticPoolOptionalParams)
Gets a list of databases in an elastic pool.
function listByElasticPool(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: DatabasesListByElasticPoolOptionalParams): PagedAsyncIterableIterator<Database, Database[], 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.
- serverName
-
string
The name of the server.
- elasticPoolName
-
string
The name of the elastic pool.
The options parameters.
Returns
listByServer(string, string, DatabasesListByServerOptionalParams)
Gets a list of databases.
function listByServer(resourceGroupName: string, serverName: string, options?: DatabasesListByServerOptionalParams): PagedAsyncIterableIterator<Database, Database[], 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.
- serverName
-
string
The name of the server.
The options parameters.
Returns
listInaccessibleByServer(string, string, DatabasesListInaccessibleByServerOptionalParams)
Gets a list of inaccessible databases in a logical server
function listInaccessibleByServer(resourceGroupName: string, serverName: string, options?: DatabasesListInaccessibleByServerOptionalParams): PagedAsyncIterableIterator<Database, Database[], 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.
- serverName
-
string
The name of the server.
The options parameters.
Returns
listMetricDefinitions(string, string, string, DatabasesListMetricDefinitionsOptionalParams)
Returns database metric definitions.
function listMetricDefinitions(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
The options parameters.
Returns
listMetrics(string, string, string, string, DatabasesListMetricsOptionalParams)
Returns database metrics.
function listMetrics(resourceGroupName: string, serverName: string, databaseName: string, filter: string, options?: DatabasesListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database.
- filter
-
string
An OData filter expression that describes a subset of metrics to return.
The options parameters.
Returns
rename(string, string, string, ResourceMoveDefinition, DatabasesRenameOptionalParams)
Renames a database.
function rename(resourceGroupName: string, serverName: string, databaseName: string, parameters: ResourceMoveDefinition, options?: DatabasesRenameOptionalParams): 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.
- serverName
-
string
The name of the server.
- databaseName
-
string
The name of the database to rename.
- parameters
- ResourceMoveDefinition
The resource move definition for renaming this database.
- options
- DatabasesRenameOptionalParams
The options parameters.
Returns
Promise<void>