public class DatabaseInner
extends com.azure.core.management.Resource
| Constructor and Description |
|---|
DatabaseInner() |
| Modifier and Type | Method and Description |
|---|---|
Integer |
autoPauseDelay()
Get the autoPauseDelay property: Time in minutes after which database is automatically paused.
|
CatalogCollationType |
catalogCollation()
Get the catalogCollation property: Collation of the metadata catalog.
|
String |
collation()
Get the collation property: The collation of the database.
|
CreateMode |
createMode()
Get the createMode property: Specifies the mode of database creation.
|
OffsetDateTime |
creationDate()
Get the creationDate property: The creation date of the database (ISO8601 format).
|
String |
currentServiceObjectiveName()
Get the currentServiceObjectiveName property: The current service level objective name of the database.
|
Sku |
currentSku()
Get the currentSku property: The name and tier of the SKU.
|
UUID |
databaseId()
Get the databaseId property: The ID of the database.
|
String |
defaultSecondaryLocation()
Get the defaultSecondaryLocation property: The default secondary region for this database.
|
OffsetDateTime |
earliestRestoreDate()
Get the earliestRestoreDate property: This records the earliest start date and time that restore is available for
this database (ISO8601 format).
|
String |
elasticPoolId()
Get the elasticPoolId property: The resource identifier of the elastic pool containing this database.
|
String |
failoverGroupId()
Get the failoverGroupId property: Failover Group resource identifier that this database belongs to.
|
String |
kind()
Get the kind property: Kind of database.
|
DatabaseLicenseType |
licenseType()
Get the licenseType property: The license type to apply for this database.
|
String |
longTermRetentionBackupResourceId()
Get the longTermRetentionBackupResourceId property: The resource identifier of the long term retention backup
associated with create operation of this database.
|
String |
managedBy()
Get the managedBy property: Resource that manages the database.
|
Long |
maxLogSizeBytes()
Get the maxLogSizeBytes property: The max log size for this database.
|
Long |
maxSizeBytes()
Get the maxSizeBytes property: The max size of the database expressed in bytes.
|
Double |
minCapacity()
Get the minCapacity property: Minimal capacity that database will always have allocated, if not paused.
|
OffsetDateTime |
pausedDate()
Get the pausedDate property: The date when database was paused by user configuration or action (ISO8601 format).
|
Integer |
readReplicaCount()
Get the readReplicaCount property: The number of readonly secondary replicas associated with the database to
which readonly application intent connections may be routed.
|
DatabaseReadScale |
readScale()
Get the readScale property: If enabled, connections that have application intent set to readonly in their
connection string may be routed to a readonly secondary replica.
|
String |
recoverableDatabaseId()
Get the recoverableDatabaseId property: The resource identifier of the recoverable database associated with
create operation of this database.
|
String |
recoveryServicesRecoveryPointId()
Get the recoveryServicesRecoveryPointId property: The resource identifier of the recovery point associated with
create operation of this database.
|
String |
requestedServiceObjectiveName()
Get the requestedServiceObjectiveName property: The requested service level objective name of the database.
|
String |
restorableDroppedDatabaseId()
Get the restorableDroppedDatabaseId property: The resource identifier of the restorable dropped database
associated with create operation of this database.
|
OffsetDateTime |
restorePointInTime()
Get the restorePointInTime property: Specifies the point in time (ISO8601 format) of the source database that
will be restored to create the new database.
|
OffsetDateTime |
resumedDate()
Get the resumedDate property: The date when database was resumed by user action or database login (ISO8601
format).
|
SampleName |
sampleName()
Get the sampleName property: The name of the sample schema to apply when creating this database.
|
Sku |
sku()
Get the sku property: The database SKU.
|
OffsetDateTime |
sourceDatabaseDeletionDate()
Get the sourceDatabaseDeletionDate property: Specifies the time that the database was deleted.
|
String |
sourceDatabaseId()
Get the sourceDatabaseId property: The resource identifier of the source database associated with create
operation of this database.
|
DatabaseStatus |
status()
Get the status property: The status of the database.
|
void |
validate()
Validates the instance.
|
DatabaseInner |
withAutoPauseDelay(Integer autoPauseDelay)
Set the autoPauseDelay property: Time in minutes after which database is automatically paused.
|
DatabaseInner |
withCatalogCollation(CatalogCollationType catalogCollation)
Set the catalogCollation property: Collation of the metadata catalog.
|
DatabaseInner |
withCollation(String collation)
Set the collation property: The collation of the database.
|
DatabaseInner |
withCreateMode(CreateMode createMode)
Set the createMode property: Specifies the mode of database creation.
|
DatabaseInner |
withElasticPoolId(String elasticPoolId)
Set the elasticPoolId property: The resource identifier of the elastic pool containing this database.
|
DatabaseInner |
withLicenseType(DatabaseLicenseType licenseType)
Set the licenseType property: The license type to apply for this database.
|
DatabaseInner |
withLongTermRetentionBackupResourceId(String longTermRetentionBackupResourceId)
Set the longTermRetentionBackupResourceId property: The resource identifier of the long term retention backup
associated with create operation of this database.
|
DatabaseInner |
withMaxSizeBytes(Long maxSizeBytes)
Set the maxSizeBytes property: The max size of the database expressed in bytes.
|
DatabaseInner |
withMinCapacity(Double minCapacity)
Set the minCapacity property: Minimal capacity that database will always have allocated, if not paused.
|
DatabaseInner |
withReadReplicaCount(Integer readReplicaCount)
Set the readReplicaCount property: The number of readonly secondary replicas associated with the database to
which readonly application intent connections may be routed.
|
DatabaseInner |
withReadScale(DatabaseReadScale readScale)
Set the readScale property: If enabled, connections that have application intent set to readonly in their
connection string may be routed to a readonly secondary replica.
|
DatabaseInner |
withRecoverableDatabaseId(String recoverableDatabaseId)
Set the recoverableDatabaseId property: The resource identifier of the recoverable database associated with
create operation of this database.
|
DatabaseInner |
withRecoveryServicesRecoveryPointId(String recoveryServicesRecoveryPointId)
Set the recoveryServicesRecoveryPointId property: The resource identifier of the recovery point associated with
create operation of this database.
|
DatabaseInner |
withRestorableDroppedDatabaseId(String restorableDroppedDatabaseId)
Set the restorableDroppedDatabaseId property: The resource identifier of the restorable dropped database
associated with create operation of this database.
|
DatabaseInner |
withRestorePointInTime(OffsetDateTime restorePointInTime)
Set the restorePointInTime property: Specifies the point in time (ISO8601 format) of the source database that
will be restored to create the new database.
|
DatabaseInner |
withSampleName(SampleName sampleName)
Set the sampleName property: The name of the sample schema to apply when creating this database.
|
DatabaseInner |
withSku(Sku sku)
Set the sku property: The database SKU.
|
DatabaseInner |
withSourceDatabaseDeletionDate(OffsetDateTime sourceDatabaseDeletionDate)
Set the sourceDatabaseDeletionDate property: Specifies the time that the database was deleted.
|
DatabaseInner |
withSourceDatabaseId(String sourceDatabaseId)
Set the sourceDatabaseId property: The resource identifier of the source database associated with create
operation of this database.
|
DatabaseInner |
withZoneRedundant(Boolean zoneRedundant)
Set the zoneRedundant property: Whether or not this database is zone redundant, which means the replicas of this
database will be spread across multiple availability zones.
|
Boolean |
zoneRedundant()
Get the zoneRedundant property: Whether or not this database is zone redundant, which means the replicas of this
database will be spread across multiple availability zones.
|
public Sku sku()
The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:
```azurecli az sql db list-editions -l <location> -o table ````
```powershell Get-AzSqlServerServiceObjective -Location <location> ````.
public DatabaseInner withSku(Sku sku)
The list of SKUs may vary by region and support offer. To determine the SKUs (including the SKU name, tier/edition, family, and capacity) that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API or one of the following commands:
```azurecli az sql db list-editions -l <location> -o table ````
```powershell Get-AzSqlServerServiceObjective -Location <location> ````.
sku - the sku value to set.public String kind()
public String managedBy()
public CreateMode createMode()
Default: regular database creation.
Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.
Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.
PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.
Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.
Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.
RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.
Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.
public DatabaseInner withCreateMode(CreateMode createMode)
Default: regular database creation.
Copy: creates a database as a copy of an existing database. sourceDatabaseId must be specified as the resource ID of the source database.
Secondary: creates a database as a secondary replica of an existing database. sourceDatabaseId must be specified as the resource ID of the existing primary database.
PointInTimeRestore: Creates a database by restoring a point in time backup of an existing database. sourceDatabaseId must be specified as the resource ID of the existing database, and restorePointInTime must be specified.
Recovery: Creates a database by restoring a geo-replicated backup. sourceDatabaseId must be specified as the recoverable database resource ID to restore.
Restore: Creates a database by restoring a backup of a deleted database. sourceDatabaseId must be specified. If sourceDatabaseId is the database's original resource ID, then sourceDatabaseDeletionDate must be specified. Otherwise sourceDatabaseId must be the restorable dropped database resource ID and sourceDatabaseDeletionDate is ignored. restorePointInTime may also be specified to restore from an earlier point in time.
RestoreLongTermRetentionBackup: Creates a database by restoring from a long term retention vault. recoveryServicesRecoveryPointResourceId must be specified as the recovery point resource ID.
Copy, Secondary, and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition.
createMode - the createMode value to set.public String collation()
public DatabaseInner withCollation(String collation)
collation - the collation value to set.public Long maxSizeBytes()
public DatabaseInner withMaxSizeBytes(Long maxSizeBytes)
maxSizeBytes - the maxSizeBytes value to set.public SampleName sampleName()
public DatabaseInner withSampleName(SampleName sampleName)
sampleName - the sampleName value to set.public String elasticPoolId()
public DatabaseInner withElasticPoolId(String elasticPoolId)
elasticPoolId - the elasticPoolId value to set.public String sourceDatabaseId()
public DatabaseInner withSourceDatabaseId(String sourceDatabaseId)
sourceDatabaseId - the sourceDatabaseId value to set.public DatabaseStatus status()
public UUID databaseId()
public OffsetDateTime creationDate()
public String currentServiceObjectiveName()
public String requestedServiceObjectiveName()
public String defaultSecondaryLocation()
public String failoverGroupId()
public OffsetDateTime restorePointInTime()
public DatabaseInner withRestorePointInTime(OffsetDateTime restorePointInTime)
restorePointInTime - the restorePointInTime value to set.public OffsetDateTime sourceDatabaseDeletionDate()
public DatabaseInner withSourceDatabaseDeletionDate(OffsetDateTime sourceDatabaseDeletionDate)
sourceDatabaseDeletionDate - the sourceDatabaseDeletionDate value to set.public String recoveryServicesRecoveryPointId()
public DatabaseInner withRecoveryServicesRecoveryPointId(String recoveryServicesRecoveryPointId)
recoveryServicesRecoveryPointId - the recoveryServicesRecoveryPointId value to set.public String longTermRetentionBackupResourceId()
public DatabaseInner withLongTermRetentionBackupResourceId(String longTermRetentionBackupResourceId)
longTermRetentionBackupResourceId - the longTermRetentionBackupResourceId value to set.public String recoverableDatabaseId()
public DatabaseInner withRecoverableDatabaseId(String recoverableDatabaseId)
recoverableDatabaseId - the recoverableDatabaseId value to set.public String restorableDroppedDatabaseId()
public DatabaseInner withRestorableDroppedDatabaseId(String restorableDroppedDatabaseId)
restorableDroppedDatabaseId - the restorableDroppedDatabaseId value to set.public CatalogCollationType catalogCollation()
public DatabaseInner withCatalogCollation(CatalogCollationType catalogCollation)
catalogCollation - the catalogCollation value to set.public Boolean zoneRedundant()
public DatabaseInner withZoneRedundant(Boolean zoneRedundant)
zoneRedundant - the zoneRedundant value to set.public DatabaseLicenseType licenseType()
public DatabaseInner withLicenseType(DatabaseLicenseType licenseType)
licenseType - the licenseType value to set.public Long maxLogSizeBytes()
public OffsetDateTime earliestRestoreDate()
public DatabaseReadScale readScale()
public DatabaseInner withReadScale(DatabaseReadScale readScale)
readScale - the readScale value to set.public Integer readReplicaCount()
public DatabaseInner withReadReplicaCount(Integer readReplicaCount)
readReplicaCount - the readReplicaCount value to set.public Sku currentSku()
public Integer autoPauseDelay()
public DatabaseInner withAutoPauseDelay(Integer autoPauseDelay)
autoPauseDelay - the autoPauseDelay value to set.public Double minCapacity()
public DatabaseInner withMinCapacity(Double minCapacity)
minCapacity - the minCapacity value to set.public OffsetDateTime pausedDate()
public OffsetDateTime resumedDate()
public void validate()
IllegalArgumentException - thrown if the instance is not valid.Copyright © 2020 Microsoft Corporation. All rights reserved.