Interface SqlDatabase

All Superinterfaces:
ChildResource<SqlServer>, ExternalChildResource<SqlDatabase, SqlServer>, HasInnerModel<DatabaseInner>, HasName, HasParent<SqlServer>, HasResourceGroup, Indexable, Refreshable<SqlDatabase>, Updatable<SqlDatabase.Update>
All Known Subinterfaces:
SqlWarehouse
public interface SqlDatabase extends ExternalChildResource<SqlDatabase, SqlServer>, HasInnerModel<DatabaseInner>, HasResourceGroup, Refreshable<SqlDatabase>, Updatable<SqlDatabase.Update>
An immutable client-side representation of an Azure SQL Server Database.

  • Method Details

    • sqlServerName

      String sqlServerName()
      Gets name of the SQL Server to which this database belongs.
      Returns:
      name of the SQL Server to which this database belongs

    • collation

      String collation()
      Gets the collation of the Azure SQL Database.
      Returns:
      the collation of the Azure SQL Database

    • creationDate

      OffsetDateTime creationDate()
      Gets the creation date of the Azure SQL Database.
      Returns:
      the creation date of the Azure SQL Database

    • currentServiceObjectiveName

      String currentServiceObjectiveName()
      Gets the current Service Level Objective Name of the Azure SQL Database.
      Returns:
      the current Service Level Objective Name of the Azure SQL Database, this is the Name of the Service Level Objective that is currently active

    • databaseId

      String databaseId()
      Gets the ID of the Azure SQL Database.
      Returns:
      the ID of the Azure SQL Database

    • earliestRestoreDate

      OffsetDateTime earliestRestoreDate()
      Gets the recovery period start date of the Azure SQL Database.
      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

      DatabaseEdition edition()
      Gets the edition of the Azure SQL Database.
      Returns:
      the edition of the Azure SQL Database

    • maxSizeBytes

      long maxSizeBytes()
      Gets the max size of the Azure SQL Database expressed in bytes.
      Returns:
      the max size of the Azure SQL Database expressed in bytes.

    • requestedServiceObjectiveName

      String requestedServiceObjectiveName()
      Gets the name of the configured Service Level Objective of the Azure SQL Database.
      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

    • status

      DatabaseStatus status()
      Gets the status of the Azure SQL Database.
      Returns:
      the status of the Azure SQL Database

    • elasticPoolId

      String elasticPoolId()
      Gets ID of the elastic pool.
      Returns:
      the elasticPoolId value

    • elasticPoolName

      String elasticPoolName()
      Gets name of the elastic pool.
      Returns:
      the elasticPoolName value

    • defaultSecondaryLocation

      String defaultSecondaryLocation()
      Gets the default secondary location.
      Returns:
      the defaultSecondaryLocation value

    • parentId

      String parentId()
      Gets the parent SQL server ID.
      Returns:
      the parent SQL server ID

    • regionName

      String regionName()
      Gets the name of the region the resource is in.
      Returns:
      the name of the region the resource is in

    • region

      com.azure.core.management.Region region()
      Gets the region the resource is in.
      Returns:
      the region the resource is in

    • isDataWarehouse

      boolean isDataWarehouse()
      Checks whether this Database is SqlWarehouse.
      Returns:
      true if this Database is SqlWarehouse

    • asWarehouse

      SqlWarehouse asWarehouse()
      Gets SqlWarehouse instance for more operations.
      Returns:
      SqlWarehouse instance for more operations

    • listRestorePoints

      List<RestorePoint> listRestorePoints()
      Gets the list of all restore points on this database.
      Returns:
      the list of all restore points on this database

    • listRestorePointsAsync

      com.azure.core.http.rest.PagedFlux<RestorePoint> listRestorePointsAsync()
      Gets the list of all restore points on this database.
      Returns:
      the list of all restore points on 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

      Mono<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

    • listReplicationLinks

      Map<String, ReplicationLink> listReplicationLinks()
      Gets all the replication links associated with this database.
      Returns:
      all the replication links associated with this database

    • listReplicationLinksAsync

      com.azure.core.http.rest.PagedFlux<ReplicationLink> listReplicationLinksAsync()
      Gets a representation of the deferred computation of all the replication links associated with this database.
      Returns:
      a representation of the deferred computation of all the replication links associated with this database

    • exportTo

      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

      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

      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

      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

      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

      @Deprecated SqlDatabaseThreatDetectionPolicy.DefinitionStages.Blank defineThreatDetectionPolicy(String policyName)
      Deprecated.
      use defineThreatDetectionPolicy(SecurityAlertPolicyName)
      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

    • defineThreatDetectionPolicy

      SqlDatabaseThreatDetectionPolicy.DefinitionStages.Blank defineThreatDetectionPolicy(SecurityAlertPolicyName 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

      SqlDatabaseThreatDetectionPolicy getThreatDetectionPolicy()
      Gets a SQL database threat detection policy.
      Returns:
      the SQL database threat detection policy for the current database

    • getDatabaseAutomaticTuning

      SqlDatabaseAutomaticTuning getDatabaseAutomaticTuning()
      Gets a SQL database automatic tuning state and options.
      Returns:
      the SQL database automatic tuning state and options

    • listUsageMetrics

      List<SqlDatabaseUsageMetric> listUsageMetrics()
      Lists the SQL database usage metrics.
      Returns:
      the SQL database usage metrics

    • listUsageMetricsAsync

      com.azure.core.http.rest.PagedFlux<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

      SqlDatabase rename(String newDatabaseName)
      Renames the database.
      Parameters:
      newDatabaseName - the new name for the database
      Returns:
      the renamed SQL database

    • renameAsync

      Mono<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

      Mono<Void> deleteAsync()
      Deletes the database asynchronously.
      Returns:
      a representation of the deferred computation of this call

    • syncGroups

      SqlSyncGroupOperations.SqlSyncGroupActionsDefinition syncGroups()
      Gets the SQL Sync Group entry point for the current database.
      Returns:
      the SQL Sync Group entry point for the current database