DatabaseUpdate interface

Package:

@azure/arm-sql

A database update resource.

Properties

autoPauseDelay	Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled
catalogCollation	Collation of the metadata catalog.
collation	The collation of the database.
createMode	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. 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.
creationDate	The creation date of the database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.
currentBackupStorageRedundancy	The storage account type used to store backups for this database. NOTE: This property will not be serialized. It can only be populated by the server.
currentServiceObjectiveName	The current service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.
currentSku	The name and tier of the SKU. NOTE: This property will not be serialized. It can only be populated by the server.
databaseId	The ID of the database. NOTE: This property will not be serialized. It can only be populated by the server.
defaultSecondaryLocation	The default secondary region for this database. NOTE: This property will not be serialized. It can only be populated by the server.
earliestRestoreDate	This records the earliest start date and time that restore is available for this database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.
elasticPoolId	The resource identifier of the elastic pool containing this database.
encryptionProtector	The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.
failoverGroupId	Failover Group resource identifier that this database belongs to. NOTE: This property will not be serialized. It can only be populated by the server.
federatedClientId	The Client id used for cross tenant per database CMK scenario
highAvailabilityReplicaCount	The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.
identity	Database identity
isInfraEncryptionEnabled	Infra encryption is enabled for this database. NOTE: This property will not be serialized. It can only be populated by the server.
isLedgerOn	Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.
keys	The resource ids of the user assigned identities to use
licenseType	The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.
longTermRetentionBackupResourceId	The resource identifier of the long term retention backup associated with create operation of this database.
maintenanceConfigurationId	Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.
manualCutover	Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier. When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database. To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.
maxLogSizeBytes	The max log size for this database. NOTE: This property will not be serialized. It can only be populated by the server.
maxSizeBytes	The max size of the database expressed in bytes.
minCapacity	Minimal capacity that database will always have allocated, if not paused
pausedDate	The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. NOTE: This property will not be serialized. It can only be populated by the server.
performCutover	To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress. This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter. This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress. When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.
preferredEnclaveType	Type of enclave requested on the database i.e. Default or VBS enclaves.
readScale	The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.
recoverableDatabaseId	The resource identifier of the recoverable database associated with create operation of this database.
recoveryServicesRecoveryPointId	The resource identifier of the recovery point associated with create operation of this database.
requestedBackupStorageRedundancy	The storage account type to be used to store backups for this database.
requestedServiceObjectiveName	The requested service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.
restorableDroppedDatabaseId	The resource identifier of the restorable dropped database associated with create operation of this database.
restorePointInTime	Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
resumedDate	The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. NOTE: This property will not be serialized. It can only be populated by the server.
sampleName	The name of the sample schema to apply when creating this database.
secondaryType	The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.
sku	The name and tier of the SKU.
sourceDatabaseDeletionDate	Specifies the time that the database was deleted.
sourceDatabaseId	The resource identifier of the source database associated with create operation of this database.
status	The status of the database. NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags.
zoneRedundant	Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

Property Details

autoPauseDelay

Time in minutes after which database is automatically paused. A value of -1 means that automatic pause is disabled

autoPauseDelay?: number

Property Value

number

catalogCollation

Collation of the metadata catalog.

catalogCollation?: string

Property Value

string

collation

The collation of the database.

collation?: string

Property Value

string

createMode

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.

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?: string

Property Value

string

creationDate

The creation date of the database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

creationDate?: Date

Property Value

Date

currentBackupStorageRedundancy

The storage account type used to store backups for this database. NOTE: This property will not be serialized. It can only be populated by the server.

currentBackupStorageRedundancy?: string

Property Value

string

currentServiceObjectiveName

The current service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

currentServiceObjectiveName?: string

Property Value

string

currentSku

The name and tier of the SKU. NOTE: This property will not be serialized. It can only be populated by the server.

currentSku?: Sku

Property Value

Sku

databaseId

The ID of the database. NOTE: This property will not be serialized. It can only be populated by the server.

databaseId?: string

Property Value

string

defaultSecondaryLocation

The default secondary region for this database. NOTE: This property will not be serialized. It can only be populated by the server.

defaultSecondaryLocation?: string

Property Value

string

earliestRestoreDate

This records the earliest start date and time that restore is available for this database (ISO8601 format). NOTE: This property will not be serialized. It can only be populated by the server.

earliestRestoreDate?: Date

Property Value

Date

elasticPoolId

The resource identifier of the elastic pool containing this database.

elasticPoolId?: string

Property Value

string

encryptionProtector

The azure key vault URI of the database if it's configured with per Database Customer Managed Keys.

encryptionProtector?: string

Property Value

string

failoverGroupId

Failover Group resource identifier that this database belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

failoverGroupId?: string

Property Value

string

federatedClientId

The Client id used for cross tenant per database CMK scenario

federatedClientId?: string

Property Value

string

highAvailabilityReplicaCount

The number of secondary replicas associated with the database that are used to provide high availability. Not applicable to a Hyperscale database within an elastic pool.

highAvailabilityReplicaCount?: number

Property Value

number

identity

Database identity

identity?: DatabaseIdentity

Property Value

DatabaseIdentity

isInfraEncryptionEnabled

Infra encryption is enabled for this database. NOTE: This property will not be serialized. It can only be populated by the server.

isInfraEncryptionEnabled?: boolean

Property Value

boolean

isLedgerOn

Whether or not this database is a ledger database, which means all tables in the database are ledger tables. Note: the value of this property cannot be changed after the database has been created.

isLedgerOn?: boolean

Property Value

boolean

keys

The resource ids of the user assigned identities to use

keys?: {[propertyName: string]: DatabaseKey}

Property Value

{[propertyName: string]: DatabaseKey}

licenseType

The license type to apply for this database. LicenseIncluded if you need a license, or BasePrice if you have a license and are eligible for the Azure Hybrid Benefit.

licenseType?: string

Property Value

string

longTermRetentionBackupResourceId

The resource identifier of the long term retention backup associated with create operation of this database.

longTermRetentionBackupResourceId?: string

Property Value

string

maintenanceConfigurationId

Maintenance configuration id assigned to the database. This configuration defines the period when the maintenance updates will occur.

maintenanceConfigurationId?: string

Property Value

string

manualCutover

Whether or not customer controlled manual cutover needs to be done during Update Database operation to Hyperscale tier.

This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier.

When manualCutover is specified, the scaling operation will wait for user input to trigger cutover to Hyperscale database.

To trigger cutover, please provide 'performCutover' parameter when the Scaling operation is in Waiting state.

manualCutover?: boolean

Property Value

boolean

maxLogSizeBytes

The max log size for this database. NOTE: This property will not be serialized. It can only be populated by the server.

maxLogSizeBytes?: number

Property Value

number

maxSizeBytes

The max size of the database expressed in bytes.

maxSizeBytes?: number

Property Value

number

minCapacity

Minimal capacity that database will always have allocated, if not paused

minCapacity?: number

Property Value

number

pausedDate

The date when database was paused by user configuration or action(ISO8601 format). Null if the database is ready. NOTE: This property will not be serialized. It can only be populated by the server.

pausedDate?: Date

Property Value

Date

performCutover

To trigger customer controlled manual cutover during the wait state while Scaling operation is in progress.

This property parameter is only applicable for scaling operations that are initiated along with 'manualCutover' parameter.

This property is only applicable when scaling database from Business Critical/General Purpose/Premium/Standard tier to Hyperscale tier is already in progress.

When performCutover is specified, the scaling operation will trigger cutover and perform role-change to Hyperscale database.

performCutover?: boolean

Property Value

boolean

preferredEnclaveType

Type of enclave requested on the database i.e. Default or VBS enclaves.

preferredEnclaveType?: string

Property Value

string

readScale

The state of read-only routing. If enabled, connections that have application intent set to readonly in their connection string may be routed to a readonly secondary replica in the same region. Not applicable to a Hyperscale database within an elastic pool.

readScale?: string

Property Value

string

recoverableDatabaseId

The resource identifier of the recoverable database associated with create operation of this database.

recoverableDatabaseId?: string

Property Value

string

recoveryServicesRecoveryPointId

The resource identifier of the recovery point associated with create operation of this database.

recoveryServicesRecoveryPointId?: string

Property Value

string

requestedBackupStorageRedundancy

The storage account type to be used to store backups for this database.

requestedBackupStorageRedundancy?: string

Property Value

string

requestedServiceObjectiveName

The requested service level objective name of the database. NOTE: This property will not be serialized. It can only be populated by the server.

requestedServiceObjectiveName?: string

Property Value

string

restorableDroppedDatabaseId

The resource identifier of the restorable dropped database associated with create operation of this database.

restorableDroppedDatabaseId?: string

Property Value

string

restorePointInTime

Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.

restorePointInTime?: Date

Property Value

Date

resumedDate

The date when database was resumed by user action or database login (ISO8601 format). Null if the database is paused. NOTE: This property will not be serialized. It can only be populated by the server.

resumedDate?: Date

Property Value

Date

sampleName

The name of the sample schema to apply when creating this database.

sampleName?: string

Property Value

string

secondaryType

The secondary type of the database if it is a secondary. Valid values are Geo, Named and Standby.

secondaryType?: string

Property Value

string

sku

The name and tier of the SKU.

sku?: Sku

Property Value

Sku

sourceDatabaseDeletionDate

Specifies the time that the database was deleted.

sourceDatabaseDeletionDate?: Date

Property Value

Date

sourceDatabaseId

The resource identifier of the source database associated with create operation of this database.

sourceDatabaseId?: string

Property Value

string

status

The status of the database. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

zoneRedundant

Whether or not this database is zone redundant, which means the replicas of this database will be spread across multiple availability zones.

zoneRedundant?: boolean

Property Value

boolean