SqlDatabase (Microsoft Azure Libraries for Java)

All Superinterfaces:

ChildResource<SqlServer>, ExternalChildResource<SqlDatabase,SqlServer>, HasInner<com.microsoft.azure.management.sql.implementation.DatabaseInner>, HasName, HasParent<SqlServer>, HasResourceGroup, Indexable, Refreshable<SqlDatabase>, Updatable<SqlDatabase.Update>

All Known Subinterfaces:

SqlWarehouse
```
@Beta(value=V1_7_0)
public interface SqlDatabase
extends ExternalChildResource<SqlDatabase,SqlServer>, HasInner<com.microsoft.azure.management.sql.implementation.DatabaseInner>, HasResourceGroup, Refreshable<SqlDatabase>, Updatable<SqlDatabase.Update>
```
An immutable client-side representation of an Azure SQL Server Database.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SqlDatabase.DefinitionStages` Grouping of all the SQL Database definition stages.
`static interface`	`SqlDatabase.SqlDatabaseDefinition<ParentT>` Container interface for all the definitions that need to be implemented.
`static interface`	`SqlDatabase.Update` The template for a SqlDatabase update operation, containing all the settings that can be modified.
`static interface`	`SqlDatabase.UpdateStages` Grouping of all the SqlDatabase update stages.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`SqlWarehouse`	`asWarehouse()`
`String`	`collation()`
`org.joda.time.DateTime`	`creationDate()`
`UUID`	`currentServiceObjectiveId()`
`String`	`databaseId()`
`String`	`defaultSecondaryLocation()`
`SqlDatabaseThreatDetectionPolicy.DefinitionStages.Blank`	`defineThreatDetectionPolicy(String policyName)` Begins a definition for a security alert policy.
`void`	`delete()` Deletes the database from the server.
`rx.Completable`	`deleteAsync()` Deletes the database asynchronously.
`org.joda.time.DateTime`	`earliestRestoreDate()`
`DatabaseEditions`	`edition()`
`String`	`elasticPoolName()`
`SqlDatabaseExportRequest.DefinitionStages.WithAuthenticationTypeAndLoginPassword`	`exportTo(Creatable<StorageAccount> storageAccountCreatable, String containerName, String fileName)` Exports the current database to a new storage account and relative path.
`SqlDatabaseExportRequest.DefinitionStages.WithAuthenticationTypeAndLoginPassword`	`exportTo(StorageAccount storageAccount, String containerName, String fileName)` Exports the current database to an existing storage account and relative path.
`SqlDatabaseExportRequest.DefinitionStages.WithStorageTypeAndKey`	`exportTo(String storageUri)` Exports the current database to a specified URI path.
`SqlDatabaseAutomaticTuning`	`getDatabaseAutomaticTuning()` Gets a SQL database automatic tuning state and options.
`SqlDatabaseThreatDetectionPolicy`	`getThreatDetectionPolicy()` Gets a SQL database threat detection policy.
`TransparentDataEncryption`	`getTransparentDataEncryption()` Gets an Azure SQL Database Transparent Data Encryption for this database.
`rx.Observable<TransparentDataEncryption>`	`getTransparentDataEncryptionAsync()` Gets an Azure SQL Database Transparent Data Encryption for this database.
`UpgradeHintInterface`	`getUpgradeHint()` Deprecated.
`SqlDatabaseImportRequest.DefinitionStages.WithAuthenticationTypeAndLoginPassword`	`importBacpac(StorageAccount storageAccount, String containerName, String fileName)` Imports into the current database from an existing storage account and relative path; the current database must be empty.
`SqlDatabaseImportRequest.DefinitionStages.WithStorageTypeAndKey`	`importBacpac(String storageUri)` Imports into the current database from a specified URI path; the current database must be empty.
`boolean`	`isDataWarehouse()`
`List<SqlDatabaseMetricDefinition>`	`listMetricDefinitions()`
`rx.Observable<SqlDatabaseMetricDefinition>`	`listMetricDefinitionsAsync()`
`List<SqlDatabaseMetric>`	`listMetrics(String filter)`
`rx.Observable<SqlDatabaseMetric>`	`listMetricsAsync(String filter)`
`Map<String,ReplicationLink>`	`listReplicationLinks()`
`rx.Observable<ReplicationLink>`	`listReplicationLinksAsync()`
`List<RestorePoint>`	`listRestorePoints()`
`rx.Observable<RestorePoint>`	`listRestorePointsAsync()`
`Map<String,ServiceTierAdvisor>`	`listServiceTierAdvisors()`
`rx.Observable<ServiceTierAdvisor>`	`listServiceTierAdvisorsAsync()`
`List<SqlDatabaseUsageMetric>`	`listUsageMetrics()` Lists the SQL database usage metrics.
`rx.Observable<SqlDatabaseUsageMetric>`	`listUsageMetricsAsync()` Asynchronously lists the SQL database usage metrics.
`List<DatabaseMetric>`	`listUsages()` Deprecated.
`long`	`maxSizeBytes()`
`String`	`parentId()`
`Region`	`region()`
`String`	`regionName()`
`SqlDatabase`	`rename(String newDatabaseName)` Renames the database.
`rx.Observable<SqlDatabase>`	`renameAsync(String newDatabaseName)` Renames the database asynchronously.
`UUID`	`requestedServiceObjectiveId()`
`ServiceObjectiveName`	`requestedServiceObjectiveName()`
`ServiceObjectiveName`	`serviceLevelObjective()`
`String`	`sqlServerName()`
`String`	`status()`
`SqlSyncGroupOperations.SqlSyncGroupActionsDefinition`	`syncGroups()`

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.ExternalChildResource
id

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable
key

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName
name

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent
parent

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable
refresh, refreshAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner
inner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup
resourceGroupName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable
update

- Method Detail
  - sqlServerName
```
String sqlServerName()
```
    Returns:
    
    name of the SQL Server to which this database belongs
  - collation
```
String collation()
```
    Returns:
    
    the collation of the Azure SQL Database
  - creationDate
```
org.joda.time.DateTime creationDate()
```
    Returns:
    
    the creation date of the Azure SQL Database
  - currentServiceObjectiveId
```
UUID currentServiceObjectiveId()
```
    Returns:
    
    the current Service Level Objective Id of the Azure SQL Database, this is the Id of the Service Level Objective that is currently active
  - databaseId
```
String databaseId()
```
    Returns:
    
    the Id of the Azure SQL Database
  - earliestRestoreDate
```
org.joda.time.DateTime earliestRestoreDate()
```
    Returns:
    
    the recovery period start date of the Azure SQL Database. This records the start date and time when recovery is available for this Azure SQL Database.
  - edition
```
DatabaseEditions edition()
```
    Returns:
    
    the edition of the Azure SQL Database
  - requestedServiceObjectiveId
```
UUID requestedServiceObjectiveId()
```
    Returns:
    
    the configured Service Level Objective Id of the Azure SQL Database, this is the Service Level Objective that is being applied to the Azure SQL Database
  - maxSizeBytes
```
long maxSizeBytes()
```
    Returns:
    
    the max size of the Azure SQL Database expressed in bytes.
  - requestedServiceObjectiveName
```
ServiceObjectiveName requestedServiceObjectiveName()
```
    Returns:
    
    the name of the configured Service Level Objective of the Azure SQL Database, this is the Service Level Objective that is being applied to the Azure SQL Database
  - serviceLevelObjective
```
ServiceObjectiveName serviceLevelObjective()
```
    Returns:
    
    the Service Level Objective of the Azure SQL Database.
  - status
```
String status()
```
    Returns:
    
    the status of the Azure SQL Database
  - elasticPoolName
```
String elasticPoolName()
```
    Returns:
    
    the elasticPoolName value
  - defaultSecondaryLocation
```
String defaultSecondaryLocation()
```
    Returns:
    
    the defaultSecondaryLocation value
  - parentId
```
String parentId()
```
    Returns:
    
    the parent SQL server ID
  - regionName
```
String regionName()
```
    Returns:
    
    the name of the region the resource is in
  - region
```
Region region()
```
    Returns:
    
    the region the resource is in
  - getUpgradeHint
```
@Deprecated
UpgradeHintInterface getUpgradeHint()
```
    Deprecated.
    
    Returns:
    
    the upgradeHint value
  - isDataWarehouse
```
boolean isDataWarehouse()
```
    Returns:
    
    true if this Database is SqlWarehouse
  - asWarehouse
```
SqlWarehouse asWarehouse()
```
    Returns:
    
    SqlWarehouse instance for more operations
  - listRestorePoints
```
List<RestorePoint> listRestorePoints()
```
    Returns:
    
    the list of all restore points on this database
  - listRestorePointsAsync
```
@Beta(value=V1_7_0)
rx.Observable<RestorePoint> listRestorePointsAsync()
```
    Returns:
    
    the list of all restore points on this database
  - listUsages
```
@Deprecated
List<DatabaseMetric> listUsages()
```
    Deprecated.
    
    Returns:
    
    the list of usages (DatabaseMetrics) of this database
  - listMetrics
```
@Beta(value=V1_7_0)
List<SqlDatabaseMetric> listMetrics(String filter)
```
    Parameters:
    
    filter - an OData filter expression that describes a subset of metrics to return.
    
    Returns:
    
    the list of metrics for this database
  - listMetricsAsync
```
@Beta(value=V1_7_0)
rx.Observable<SqlDatabaseMetric> listMetricsAsync(String filter)
```
    Parameters:
    
    filter - an OData filter expression that describes a subset of metrics to return.
    
    Returns:
    
    a representation of the deferred computation of the metrics for this database
  - listMetricDefinitions
```
@Beta(value=V1_7_0)
List<SqlDatabaseMetricDefinition> listMetricDefinitions()
```
    Returns:
    
    the list of metric definitions for this database
  - listMetricDefinitionsAsync
```
@Beta(value=V1_7_0)
rx.Observable<SqlDatabaseMetricDefinition> listMetricDefinitionsAsync()
```
    Returns:
    
    a representation of the deferred computation of the metric definitions for this database
  - getTransparentDataEncryption
```
TransparentDataEncryption getTransparentDataEncryption()
```
    Gets an Azure SQL Database Transparent Data Encryption for this database.
    
    Returns:
    
    an Azure SQL Database Transparent Data Encryption for this database
  - getTransparentDataEncryptionAsync
```
@Beta(value=V1_7_0)
rx.Observable<TransparentDataEncryption> getTransparentDataEncryptionAsync()
```
    Gets an Azure SQL Database Transparent Data Encryption for this database.
    
    Returns:
    
    a representation of the deferred computation of an Azure SQL Database Transparent Data Encryption for this database
  - listServiceTierAdvisors
```
Map<String,ServiceTierAdvisor> listServiceTierAdvisors()
```
    Returns:
    
    information about service tier advisors for the current database
  - listServiceTierAdvisorsAsync
```
@Beta(value=V1_7_0)
rx.Observable<ServiceTierAdvisor> listServiceTierAdvisorsAsync()
```
    Returns:
    
    a representation of the deferred computation of the information about service tier advisors for this database
  - listReplicationLinks
```
Map<String,ReplicationLink> listReplicationLinks()
```
    Returns:
    
    all the replication links associated with this database
  - listReplicationLinksAsync
```
@Beta(value=V1_7_0)
rx.Observable<ReplicationLink> listReplicationLinksAsync()
```
    Returns:
    
    a representation of the deferred computation of all the replication links associated with this database
  - exportTo
```
@Beta(value=V1_7_0)
SqlDatabaseExportRequest.DefinitionStages.WithStorageTypeAndKey exportTo(String storageUri)
```
    Exports the current database to a specified URI path.
    
    Parameters:
    
    storageUri - the storage URI to use
    
    Returns:
    
    response object
  - exportTo
```
@Beta(value=V1_7_0)
SqlDatabaseExportRequest.DefinitionStages.WithAuthenticationTypeAndLoginPassword exportTo(StorageAccount storageAccount,
                                                                                                              String containerName,
                                                                                                              String fileName)
```
    Exports the current database to an existing storage account and relative path.
    
    Parameters:
    
    storageAccount - an existing storage account to be used
    
    containerName - the container name within the storage account to use
    
    fileName - the exported database file name
    
    Returns:
    
    response object
  - exportTo
```
@Beta(value=V1_7_0)
SqlDatabaseExportRequest.DefinitionStages.WithAuthenticationTypeAndLoginPassword exportTo(Creatable<StorageAccount> storageAccountCreatable,
                                                                                                              String containerName,
                                                                                                              String fileName)
```
    Exports the current database to a new storage account and relative path.
    
    Parameters:
    
    storageAccountCreatable - a storage account to be created as part of this execution flow
    
    containerName - the container name within the storage account to use
    
    fileName - the exported database file name
    
    Returns:
    
    response object
  - importBacpac
```
@Beta(value=V1_7_0)
SqlDatabaseImportRequest.DefinitionStages.WithStorageTypeAndKey importBacpac(String storageUri)
```
    Imports into the current database from a specified URI path; the current database must be empty.
    
    Parameters:
    
    storageUri - the storage URI to use
    
    Returns:
    
    response object
  - importBacpac
```
@Beta(value=V1_7_0)
SqlDatabaseImportRequest.DefinitionStages.WithAuthenticationTypeAndLoginPassword importBacpac(StorageAccount storageAccount,
                                                                                                                  String containerName,
                                                                                                                  String fileName)
```
    Imports into the current database from an existing storage account and relative path; the current database must be empty.
    
    Parameters:
    
    storageAccount - an existing storage account to be used
    
    containerName - the container name within the storage account to use
    
    fileName - the exported database file name
    
    Returns:
    
    response object
  - defineThreatDetectionPolicy
```
@Beta(value=V1_7_0)
SqlDatabaseThreatDetectionPolicy.DefinitionStages.Blank defineThreatDetectionPolicy(String policyName)
```
    Begins a definition for a security alert policy.
    
    Parameters:
    
    policyName - the name of the security alert policy
    
    Returns:
    
    the first stage of the SqlDatabaseThreatDetectionPolicy definition
  - getThreatDetectionPolicy
```
@Beta(value=V1_7_0)
SqlDatabaseThreatDetectionPolicy getThreatDetectionPolicy()
```
    Gets a SQL database threat detection policy.
    
    Returns:
    
    the SQL database threat detection policy for the current database
  - getDatabaseAutomaticTuning
```
@Beta(value=V1_8_0)
SqlDatabaseAutomaticTuning getDatabaseAutomaticTuning()
```
    Gets a SQL database automatic tuning state and options.
    
    Returns:
    
    the SQL database automatic tuning state and options
  - listUsageMetrics
```
@Beta(value=V1_8_0)
List<SqlDatabaseUsageMetric> listUsageMetrics()
```
    Lists the SQL database usage metrics.
    
    Returns:
    
    the SQL database usage metrics
  - listUsageMetricsAsync
```
@Beta(value=V1_8_0)
rx.Observable<SqlDatabaseUsageMetric> listUsageMetricsAsync()
```
    Asynchronously lists the SQL database usage metrics.
    
    Returns:
    
    a representation of the deferred computation of this call returning the SQL database usage metrics
  - rename
```
@Beta(value=V1_8_0)
SqlDatabase rename(String newDatabaseName)
```
    Renames the database.
    
    Parameters:
    
    newDatabaseName - the new name for the database
    
    Returns:
    
    the renamed SQL database
  - renameAsync
```
@Beta(value=V1_8_0)
rx.Observable<SqlDatabase> renameAsync(String newDatabaseName)
```
    Renames the database asynchronously.
    
    Parameters:
    
    newDatabaseName - the new name for the database
    
    Returns:
    
    a representation of the deferred computation of this call
  - delete
```
void delete()
```
    Deletes the database from the server.
  - deleteAsync
```
@Beta(value=V1_7_0)
rx.Completable deleteAsync()
```
    Deletes the database asynchronously.
    
    Returns:
    
    a representation of the deferred computation of this call
  - syncGroups
```
@Beta(value=V1_9_0)
SqlSyncGroupOperations.SqlSyncGroupActionsDefinition syncGroups()
```
    Returns:
    
    the SQL Sync Group entry point for the current database

Interface SqlDatabase

Nested Class Summary

Method Summary

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.ExternalChildResource

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Indexable

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasName

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Refreshable

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.HasInner

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasResourceGroup

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.model.Updatable

Method Detail

sqlServerName

collation

creationDate

currentServiceObjectiveId

databaseId

earliestRestoreDate

edition

requestedServiceObjectiveId

maxSizeBytes

requestedServiceObjectiveName

serviceLevelObjective

status

elasticPoolName

defaultSecondaryLocation

parentId

regionName

region

getUpgradeHint

isDataWarehouse

asWarehouse

listRestorePoints

listRestorePointsAsync

listUsages

listMetrics

listMetricsAsync

listMetricDefinitions

listMetricDefinitionsAsync

getTransparentDataEncryption

getTransparentDataEncryptionAsync

listServiceTierAdvisors

listServiceTierAdvisorsAsync

listReplicationLinks

listReplicationLinksAsync

exportTo

exportTo

exportTo

importBacpac

importBacpac

defineThreatDetectionPolicy

getThreatDetectionPolicy

getDatabaseAutomaticTuning

listUsageMetrics

listUsageMetricsAsync

rename

renameAsync

delete

deleteAsync

syncGroups