Package version:

Interface Databases

Interface representing a Databases.

Hierarchy

Databases

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
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.
- serverName: string
  
  The name of the server.
- databaseName: string
  
  The name of the database.
- parameters: Database
  
  The requested database resource state.
- Optional options: DatabasesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Database>, Database>>
- Defined in operationsInterfaces/databases.ts:138

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: Database, options?: DatabasesCreateOrUpdateOptionalParams): Promise<Database>
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.
- serverName: string
  
  The name of the server.
- databaseName: string
  
  The name of the database.
- parameters: Database
  
  The requested database resource state.
- Optional options: DatabasesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<Database>
- Defined in operationsInterfaces/databases.ts:159

beginDelete

beginDelete(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes the 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.
- Optional options: DatabasesDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/databases.ts:174

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesDeleteOptionalParams): Promise<void>
Deletes the 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.
- Optional options: DatabasesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/databases.ts:188

beginExport

beginExport(resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams): Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>
Exports a 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: ExportDatabaseDefinition
  
  The database export request parameters.
- Optional options: DatabasesExportOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>
- Defined in operationsInterfaces/databases.ts:240

beginExportAndWait

beginExportAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: ExportDatabaseDefinition, options?: DatabasesExportOptionalParams): Promise<ImportExportOperationResult>
Exports a 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: ExportDatabaseDefinition
  
  The database export request parameters.
- Optional options: DatabasesExportOptionalParams
  
  The options parameters.
Returns Promise<ImportExportOperationResult>
- Defined in operationsInterfaces/databases.ts:261

beginFailover

beginFailover(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Failovers a 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 failover.
- Optional options: DatabasesFailoverOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/databases.ts:276

beginFailoverAndWait

beginFailoverAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesFailoverOptionalParams): Promise<void>
Failovers a 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 failover.
- Optional options: DatabasesFailoverOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/databases.ts:290

beginImport

beginImport(resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams): Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>
Imports a bacpac into a new 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: ImportExistingDatabaseDefinition
  
  The database import request parameters.
- Optional options: DatabasesImportOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>
- Defined in operationsInterfaces/databases.ts:305

beginImportAndWait

beginImportAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: ImportExistingDatabaseDefinition, options?: DatabasesImportOptionalParams): Promise<ImportExportOperationResult>
Imports a bacpac into a new 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: ImportExistingDatabaseDefinition
  
  The database import request parameters.
- Optional options: DatabasesImportOptionalParams
  
  The options parameters.
Returns Promise<ImportExportOperationResult>
- Defined in operationsInterfaces/databases.ts:326

beginPause

beginPause(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
Pauses a 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.
- Optional options: DatabasesPauseOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Database>, Database>>
- Defined in operationsInterfaces/databases.ts:357

beginPauseAndWait

beginPauseAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesPauseOptionalParams): Promise<Database>
Pauses a 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.
- Optional options: DatabasesPauseOptionalParams
  
  The options parameters.
Returns Promise<Database>
- Defined in operationsInterfaces/databases.ts:376

beginResume

beginResume(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
Resumes a 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.
- Optional options: DatabasesResumeOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Database>, Database>>
- Defined in operationsInterfaces/databases.ts:390

beginResumeAndWait

beginResumeAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesResumeOptionalParams): Promise<Database>
Resumes a 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.
- Optional options: DatabasesResumeOptionalParams
  
  The options parameters.
Returns Promise<Database>
- Defined in operationsInterfaces/databases.ts:409

beginUpdate

beginUpdate(resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Database>, Database>>
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.
- serverName: string
  
  The name of the server.
- databaseName: string
  
  The name of the database.
- parameters: DatabaseUpdate
  
  The requested database resource state.
- Optional options: DatabasesUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Database>, Database>>
- Defined in operationsInterfaces/databases.ts:203

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: DatabaseUpdate, options?: DatabasesUpdateOptionalParams): Promise<Database>
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.
- serverName: string
  
  The name of the server.
- databaseName: string
  
  The name of the database.
- parameters: DatabaseUpdate
  
  The requested database resource state.
- Optional options: DatabasesUpdateOptionalParams
  
  The options parameters.
Returns Promise<Database>
- Defined in operationsInterfaces/databases.ts:224

beginUpgradeDataWarehouse

beginUpgradeDataWarehouse(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Upgrades a data warehouse.
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.
- Optional options: DatabasesUpgradeDataWarehouseOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/databases.ts:423

beginUpgradeDataWarehouseAndWait

beginUpgradeDataWarehouseAndWait(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesUpgradeDataWarehouseOptionalParams): Promise<void>
Upgrades a data warehouse.
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.
- Optional options: DatabasesUpgradeDataWarehouseOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/databases.ts:437

get

get(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesGetOptionalParams): Promise<Database>
Gets a 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.
- Optional options: DatabasesGetOptionalParams
  
  The options parameters.
Returns Promise<Database>
- Defined in operationsInterfaces/databases.ts:123

listByElasticPool

listByElasticPool(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: DatabasesListByElasticPoolOptionalParams): PagedAsyncIterableIterator<Database>
Gets a list of databases in an elastic pool.
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.
- Optional options: DatabasesListByElasticPoolOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Database>
- Defined in operationsInterfaces/databases.ts:97

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: DatabasesListByServerOptionalParams): PagedAsyncIterableIterator<Database>
Gets a list of 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.
- serverName: string
  
  The name of the server.
- Optional options: DatabasesListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Database>
- Defined in operationsInterfaces/databases.ts:84

listInaccessibleByServer

listInaccessibleByServer(resourceGroupName: string, serverName: string, options?: DatabasesListInaccessibleByServerOptionalParams): PagedAsyncIterableIterator<Database>
Gets a list of inaccessible databases in a logical server
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.
- Optional options: DatabasesListInaccessibleByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Database>
- Defined in operationsInterfaces/databases.ts:110

listMetricDefinitions

listMetricDefinitions(resourceGroupName: string, serverName: string, databaseName: string, options?: DatabasesListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition>
Returns database metric definitions.
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.
- Optional options: DatabasesListMetricDefinitionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MetricDefinition>
- Defined in operationsInterfaces/databases.ts:71

listMetrics

listMetrics(resourceGroupName: string, serverName: string, databaseName: string, filter: string, options?: DatabasesListMetricsOptionalParams): PagedAsyncIterableIterator<Metric>
Returns database metrics.
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.
- Optional options: DatabasesListMetricsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Metric>
- Defined in operationsInterfaces/databases.ts:56

rename

rename(resourceGroupName: string, serverName: string, databaseName: string, parameters: ResourceMoveDefinition, options?: DatabasesRenameOptionalParams): Promise<void>
Renames a 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 rename.
- parameters: ResourceMoveDefinition
  
  The resource move definition for renaming this database.
- Optional options: DatabasesRenameOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/databases.ts:342

Interface Databases

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

databaseName: string

parameters: Database

Optional options: DatabasesCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<Database>, Database>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

parameters: Database

Optional options: DatabasesCreateOrUpdateOptionalParams

Returns Promise<Database>

beginDelete

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: DatabasesDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: DatabasesDeleteOptionalParams

Returns Promise<void>

beginExport

Parameters

resourceGroupName: string

serverName: string

databaseName: string

parameters: ExportDatabaseDefinition

Optional options: DatabasesExportOptionalParams

Returns Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>

beginExportAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

parameters: ExportDatabaseDefinition

Optional options: DatabasesExportOptionalParams

Returns Promise<ImportExportOperationResult>

beginFailover

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: DatabasesFailoverOptionalParams

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

beginFailoverAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

Optional options: DatabasesFailoverOptionalParams

Returns Promise<void>

beginImport

Parameters

resourceGroupName: string

serverName: string

databaseName: string

parameters: ImportExistingDatabaseDefinition

Optional options: DatabasesImportOptionalParams

Returns Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>

beginImportAndWait

Parameters

resourceGroupName: string

serverName: string

databaseName: string

parameters: ImportExistingDatabaseDefinition

Optional options: DatabasesImportOptionalParams

`Optional` options: DatabasesCreateOrUpdateOptionalParams

`Optional` options: DatabasesCreateOrUpdateOptionalParams

`Optional` options: DatabasesDeleteOptionalParams

`Optional` options: DatabasesDeleteOptionalParams

`Optional` options: DatabasesExportOptionalParams

`Optional` options: DatabasesExportOptionalParams

`Optional` options: DatabasesFailoverOptionalParams

`Optional` options: DatabasesFailoverOptionalParams

`Optional` options: DatabasesImportOptionalParams

`Optional` options: DatabasesImportOptionalParams

`Optional` options: DatabasesPauseOptionalParams

`Optional` options: DatabasesPauseOptionalParams

`Optional` options: DatabasesResumeOptionalParams

`Optional` options: DatabasesResumeOptionalParams

`Optional` options: DatabasesUpdateOptionalParams

`Optional` options: DatabasesUpdateOptionalParams

`Optional` options: DatabasesUpgradeDataWarehouseOptionalParams

`Optional` options: DatabasesUpgradeDataWarehouseOptionalParams

`Optional` options: DatabasesGetOptionalParams