DatabaseUpdate Class
- java.
lang. Object - com.
microsoft. azure. ProxyResource - com.
microsoft. azure. management. sql. DatabaseUpdate
- com.
- com.
public class DatabaseUpdate
extends com.microsoft.azure.ProxyResource
Represents a database update.
Constructor Summary
| Constructor | Description | |
|---|---|---|
| DatabaseUpdate() | ||
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| java.lang.String |
collation()
Get the collation of the database. |
| java.lang.Long |
containmentState()
Get the containment state of the database. |
|
Create |
createMode()
Get specifies the mode of database creation. |
| org.joda.time.DateTime |
creationDate()
Get the creation date of the database (ISO8601 format). |
| java.util.UUID |
currentServiceObjectiveId()
Get the current service level objective ID of the database. |
| java.util.UUID |
databaseId()
Get the ID of the database. |
| java.lang.String |
defaultSecondaryLocation()
Get the default secondary region for this database. |
| org.joda.time.DateTime |
earliestRestoreDate()
Get this records the earliest start date and time that restore is available for this database (ISO8601 format). |
|
Database |
edition()
Get the edition of the database. |
| java.lang.String |
elasticPoolName()
Get the name of the elastic pool the database is in. |
| java.lang.String |
failoverGroupId()
Get the resource identifier of the failover group containing this database. |
| java.lang.String |
maxSizeBytes()
Get the max size of the database expressed in bytes. |
|
Read |
readScale()
Get conditional. |
|
java.util.List<Recommended |
recommendedIndex()
Get the recommended indices for this database. |
| java.lang.String |
recoveryServicesRecoveryPointResourceId()
Get conditional. |
| java.util.UUID |
requestedServiceObjectiveId()
Get the configured service level objective ID of the database. |
|
Service |
requestedServiceObjectiveName()
Get the name of the configured service level objective of the database. |
| org.joda.time.DateTime |
restorePointInTime()
Get conditional. |
|
Sample |
sampleName()
Get indicates the name of the sample schema to apply when creating this database. |
|
Service |
serviceLevelObjective()
Get the current service level objective of the database. |
| java.util.List<com.microsoft.azure.management.sql.implementation.ServiceTierAdvisorInner> |
serviceTierAdvisors()
Get the list of service tier advisors for this database. |
| org.joda.time.DateTime |
sourceDatabaseDeletionDate()
Get conditional. |
| java.lang.String |
sourceDatabaseId()
Get conditional. |
| java.lang.String |
status()
Get the status of the database. |
| java.util.Map<java.lang.String,java.lang.String> |
tags()
Get resource tags. |
| java.util.List<com.microsoft.azure.management.sql.implementation.TransparentDataEncryptionInner> |
transparentDataEncryption()
Get the transparent data encryption info for this database. |
|
Database |
withCollation(String collation)
Set the collation of the database. |
|
Database |
withCreateMode(CreateMode createMode)
Set specifies the mode of database creation. |
|
Database |
withEdition(DatabaseEdition edition)
Set the edition of the database. |
|
Database |
withElasticPoolName(String elasticPoolName)
Set the name of the elastic pool the database is in. |
|
Database |
withMaxSizeBytes(String maxSizeBytes)
Set the max size of the database expressed in bytes. |
|
Database |
withReadScale(ReadScale readScale)
Set conditional. |
|
Database |
withRecoveryServicesRecoveryPointResourceId(String recoveryServicesRecoveryPointResourceId)
Set conditional. |
|
Database |
withRequestedServiceObjectiveId(UUID requestedServiceObjectiveId)
Set the configured service level objective ID of the database. |
|
Database |
withRequestedServiceObjectiveName(ServiceObjectiveName requestedServiceObjectiveName)
Set the name of the configured service level objective of the database. |
|
Database |
withRestorePointInTime(DateTime restorePointInTime)
Set conditional. |
|
Database |
withSampleName(SampleName sampleName)
Set indicates the name of the sample schema to apply when creating this database. |
|
Database |
withSourceDatabaseDeletionDate(DateTime sourceDatabaseDeletionDate)
Set conditional. |
|
Database |
withSourceDatabaseId(String sourceDatabaseId)
Set conditional. |
|
Database |
withTags(Map<String,String> tags)
Set resource tags. |
|
Database |
withZoneRedundant(Boolean zoneRedundant)
Set whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. |
| java.lang.Boolean |
zoneRedundant()
Get whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones. |
Methods inherited from com.microsoft.azure.ProxyResource
Methods inherited from java.lang.Object
Constructor Details
DatabaseUpdate
public DatabaseUpdate()
Method Details
collation
public String collation()
Get the collation of the database. If createMode is not Default, this value is ignored.
Returns:
containmentState
public Long containmentState()
Get the containment state of the database.
Returns:
createMode
public CreateMode createMode()
Get specifies the mode of database creation. 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. OnlineSecondary/NonReadableSecondary: creates a database as a (readable or nonreadable) 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, NonReadableSecondary, OnlineSecondary and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: 'Copy', 'Default', 'NonReadableSecondary', 'OnlineSecondary', 'PointInTimeRestore', 'Recovery', 'Restore', 'RestoreLongTermRetentionBackup'.
Returns:
creationDate
public DateTime creationDate()
Get the creation date of the database (ISO8601 format).
Returns:
currentServiceObjectiveId
public UUID currentServiceObjectiveId()
Get the current service level objective ID of the database. This is the ID of the service level objective that is currently active.
Returns:
databaseId
public UUID databaseId()
Get the ID of the database.
Returns:
defaultSecondaryLocation
public String defaultSecondaryLocation()
Get the default secondary region for this database.
Returns:
earliestRestoreDate
public DateTime earliestRestoreDate()
Get this records the earliest start date and time that restore is available for this database (ISO8601 format).
Returns:
edition
public DatabaseEdition edition()
Get the edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored. 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 -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` . Possible values include: 'Web', 'Business', 'Basic', 'Standard', 'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System', 'System2', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale'.
Returns:
elasticPoolName
public String elasticPoolName()
Get the name of the elastic pool the database is in. If elasticPoolName and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveName is ignored. Not supported for DataWarehouse edition.
Returns:
failoverGroupId
public String failoverGroupId()
Get the resource identifier of the failover group containing this database.
Returns:
maxSizeBytes
public String maxSizeBytes()
Get the max size of the database expressed in bytes. If createMode is not Default, this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: "Capabilities_ListByLocation.".
Returns:
readScale
public ReadScale readScale()
Get conditional. If the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition. Possible values include: 'Enabled', 'Disabled'.
Returns:
recommendedIndex
public List
Get the recommended indices for this database.
Returns:
recoveryServicesRecoveryPointResourceId
public String recoveryServicesRecoveryPointResourceId()
Get conditional. If createMode is RestoreLongTermRetentionBackup, then this value is required. Specifies the resource ID of the recovery point to restore from.
Returns:
requestedServiceObjectiveId
public UUID requestedServiceObjectiveId()
Get the configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of currentServiceObjectiveId property. If requestedServiceObjectiveId and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveId overrides the value of requestedServiceObjectiveName. The list of SKUs may vary by region and support offer. To determine the service objective ids that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API.
Returns:
requestedServiceObjectiveName
public ServiceObjectiveName requestedServiceObjectiveName()
Get the name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property. 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 -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` . Possible values include: 'System', 'System0', 'System1', 'System2', 'System3', 'System4', 'System2L', 'System3L', 'System4L', 'Free', 'Basic', 'S0', 'S1', 'S2', 'S3', 'S4', 'S6', 'S7', 'S9', 'S12', 'P1', 'P2', 'P3', 'P4', 'P6', 'P11', 'P15', 'PRS1', 'PRS2', 'PRS4', 'PRS6', 'DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1000c', 'DW1500', 'DW1500c', 'DW2000', 'DW2000c', 'DW3000', 'DW2500c', 'DW3000c', 'DW6000', 'DW5000c', 'DW6000c', 'DW7500c', 'DW10000c', 'DW15000c', 'DW30000c', 'DS100', 'DS200', 'DS300', 'DS400', 'DS500', 'DS600', 'DS1000', 'DS1200', 'DS1500', 'DS2000', 'ElasticPool'.
Returns:
restorePointInTime
public DateTime restorePointInTime()
Get conditional. If createMode is PointInTimeRestore, this value is required. If createMode is Restore, this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value.
Returns:
sampleName
public SampleName sampleName()
Get indicates the name of the sample schema to apply when creating this database. If createMode is not Default, this value is ignored. Not supported for DataWarehouse edition. Possible values include: 'AdventureWorksLT'.
Returns:
serviceLevelObjective
public ServiceObjectiveName serviceLevelObjective()
Get the current service level objective of the database. Possible values include: 'System', 'System0', 'System1', 'System2', 'System3', 'System4', 'System2L', 'System3L', 'System4L', 'Free', 'Basic', 'S0', 'S1', 'S2', 'S3', 'S4', 'S6', 'S7', 'S9', 'S12', 'P1', 'P2', 'P3', 'P4', 'P6', 'P11', 'P15', 'PRS1', 'PRS2', 'PRS4', 'PRS6', 'DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1000c', 'DW1500', 'DW1500c', 'DW2000', 'DW2000c', 'DW3000', 'DW2500c', 'DW3000c', 'DW6000', 'DW5000c', 'DW6000c', 'DW7500c', 'DW10000c', 'DW15000c', 'DW30000c', 'DS100', 'DS200', 'DS300', 'DS400', 'DS500', 'DS600', 'DS1000', 'DS1200', 'DS1500', 'DS2000', 'ElasticPool'.
Returns:
serviceTierAdvisors
public List
Get the list of service tier advisors for this database. Expanded property.
Returns:
sourceDatabaseDeletionDate
public DateTime sourceDatabaseDeletionDate()
Get conditional. If createMode is Restore and sourceDatabaseId is the deleted database's original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.
Returns:
sourceDatabaseId
public String sourceDatabaseId()
Get conditional. If createMode is Copy, NonReadableSecondary, OnlineSecondary, PointInTimeRestore, Recovery, or Restore, then this value is required. Specifies the resource ID of the source database. If createMode is NonReadableSecondary or OnlineSecondary, the name of the source database must be the same as the new database being created.
Returns:
status
public String status()
Get the status of the database.
Returns:
tags
public Map
Get resource tags.
Returns:
transparentDataEncryption
public List
Get the transparent data encryption info for this database.
Returns:
withCollation
public DatabaseUpdate withCollation(String collation)
Set the collation of the database. If createMode is not Default, this value is ignored.
Parameters:
Returns:
withCreateMode
public DatabaseUpdate withCreateMode(CreateMode createMode)
Set specifies the mode of database creation. 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. OnlineSecondary/NonReadableSecondary: creates a database as a (readable or nonreadable) 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, NonReadableSecondary, OnlineSecondary and RestoreLongTermRetentionBackup are not supported for DataWarehouse edition. Possible values include: 'Copy', 'Default', 'NonReadableSecondary', 'OnlineSecondary', 'PointInTimeRestore', 'Recovery', 'Restore', 'RestoreLongTermRetentionBackup'.
Parameters:
Returns:
withEdition
public DatabaseUpdate withEdition(DatabaseEdition edition)
Set the edition of the database. The DatabaseEditions enumeration contains all the valid editions. If createMode is NonReadableSecondary or OnlineSecondary, this value is ignored. 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 -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` . Possible values include: 'Web', 'Business', 'Basic', 'Standard', 'Premium', 'PremiumRS', 'Free', 'Stretch', 'DataWarehouse', 'System', 'System2', 'GeneralPurpose', 'BusinessCritical', 'Hyperscale'.
Parameters:
Returns:
withElasticPoolName
public DatabaseUpdate withElasticPoolName(String elasticPoolName)
Set the name of the elastic pool the database is in. If elasticPoolName and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveName is ignored. Not supported for DataWarehouse edition.
Parameters:
Returns:
withMaxSizeBytes
public DatabaseUpdate withMaxSizeBytes(String maxSizeBytes)
Set the max size of the database expressed in bytes. If createMode is not Default, this value is ignored. To see possible values, query the capabilities API (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities) referred to by operationId: "Capabilities_ListByLocation.".
Parameters:
Returns:
withReadScale
public DatabaseUpdate withReadScale(ReadScale readScale)
Set conditional. If the database is a geo-secondary, readScale indicates whether read-only connections are allowed to this database or not. Not supported for DataWarehouse edition. Possible values include: 'Enabled', 'Disabled'.
Parameters:
Returns:
withRecoveryServicesRecoveryPointResourceId
public DatabaseUpdate withRecoveryServicesRecoveryPointResourceId(String recoveryServicesRecoveryPointResourceId)
Set conditional. If createMode is RestoreLongTermRetentionBackup, then this value is required. Specifies the resource ID of the recovery point to restore from.
Parameters:
Returns:
withRequestedServiceObjectiveId
public DatabaseUpdate withRequestedServiceObjectiveId(UUID requestedServiceObjectiveId)
Set the configured service level objective ID of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of currentServiceObjectiveId property. If requestedServiceObjectiveId and requestedServiceObjectiveName are both updated, the value of requestedServiceObjectiveId overrides the value of requestedServiceObjectiveName. The list of SKUs may vary by region and support offer. To determine the service objective ids that are available to your subscription in an Azure region, use the `Capabilities_ListByLocation` REST API.
Parameters:
Returns:
withRequestedServiceObjectiveName
public DatabaseUpdate withRequestedServiceObjectiveName(ServiceObjectiveName requestedServiceObjectiveName)
Set the name of the configured service level objective of the database. This is the service level objective that is in the process of being applied to the database. Once successfully updated, it will match the value of serviceLevelObjective property. 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 -o table ```` ```powershell Get-AzSqlServerServiceObjective -Location ```` . Possible values include: 'System', 'System0', 'System1', 'System2', 'System3', 'System4', 'System2L', 'System3L', 'System4L', 'Free', 'Basic', 'S0', 'S1', 'S2', 'S3', 'S4', 'S6', 'S7', 'S9', 'S12', 'P1', 'P2', 'P3', 'P4', 'P6', 'P11', 'P15', 'PRS1', 'PRS2', 'PRS4', 'PRS6', 'DW100', 'DW200', 'DW300', 'DW400', 'DW500', 'DW600', 'DW1000', 'DW1200', 'DW1000c', 'DW1500', 'DW1500c', 'DW2000', 'DW2000c', 'DW3000', 'DW2500c', 'DW3000c', 'DW6000', 'DW5000c', 'DW6000c', 'DW7500c', 'DW10000c', 'DW15000c', 'DW30000c', 'DS100', 'DS200', 'DS300', 'DS400', 'DS500', 'DS600', 'DS1000', 'DS1200', 'DS1500', 'DS2000', 'ElasticPool'.
Parameters:
Returns:
withRestorePointInTime
public DatabaseUpdate withRestorePointInTime(DateTime restorePointInTime)
Set conditional. If createMode is PointInTimeRestore, this value is required. If createMode is Restore, this value is optional. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. Must be greater than or equal to the source database's earliestRestoreDate value.
Parameters:
Returns:
withSampleName
public DatabaseUpdate withSampleName(SampleName sampleName)
Set indicates the name of the sample schema to apply when creating this database. If createMode is not Default, this value is ignored. Not supported for DataWarehouse edition. Possible values include: 'AdventureWorksLT'.
Parameters:
Returns:
withSourceDatabaseDeletionDate
public DatabaseUpdate withSourceDatabaseDeletionDate(DateTime sourceDatabaseDeletionDate)
Set conditional. If createMode is Restore and sourceDatabaseId is the deleted database's original resource id when it existed (as opposed to its current restorable dropped database id), then this value is required. Specifies the time that the database was deleted.
Parameters:
Returns:
withSourceDatabaseId
public DatabaseUpdate withSourceDatabaseId(String sourceDatabaseId)
Set conditional. If createMode is Copy, NonReadableSecondary, OnlineSecondary, PointInTimeRestore, Recovery, or Restore, then this value is required. Specifies the resource ID of the source database. If createMode is NonReadableSecondary or OnlineSecondary, the name of the source database must be the same as the new database being created.
Parameters:
Returns:
withTags
public DatabaseUpdate withTags(Map
Set resource tags.
Parameters:
Returns:
withZoneRedundant
public DatabaseUpdate withZoneRedundant(Boolean zoneRedundant)
Set whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
Parameters:
Returns:
zoneRedundant
public Boolean zoneRedundant()
Get whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for