ManagedDatabaseUpdate interface
An managed database update.
Properties
| auto |
Whether to auto complete restore of this managed database. |
| catalog |
Collation of the metadata catalog. |
| collation | Collation of the managed database. |
| create |
Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required). |
| creation |
Creation date of the database. NOTE: This property will not be serialized. It can only be populated by the server. |
| cross |
The restorable cross-subscription dropped database resource id to restore when creating this database. |
| cross |
The resource identifier of the cross-subscription source database associated with create operation of this database. |
| cross |
Target managed instance id used in cross-subscription restore. |
| default |
Geo paired region. NOTE: This property will not be serialized. It can only be populated by the server. |
| earliest |
Earliest restore point in time for point in time restore. NOTE: This property will not be serialized. It can only be populated by the server. |
| failover |
Instance Failover Group resource identifier that this managed database belongs to. NOTE: This property will not be serialized. It can only be populated by the server. |
| last |
Last backup file name for restore of this managed database. |
| long |
The name of the Long Term Retention backup to be used for restore of this managed database. |
| recoverable |
The resource identifier of the recoverable database associated with create operation of this database. |
| restorable |
The restorable dropped database resource id to restore when creating this database. |
| restore |
Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. |
| source |
The resource identifier of the source database associated with create operation of this database. |
| status | Status of the database. NOTE: This property will not be serialized. It can only be populated by the server. |
| storage |
Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed. |
| storage |
Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token. |
| storage |
Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored. |
| tags | Resource tags. |
Property Details
autoCompleteRestore
Whether to auto complete restore of this managed database.
autoCompleteRestore?: booleanProperty Value
boolean
catalogCollation
Collation of the metadata catalog.
catalogCollation?: stringProperty Value
string
collation
Collation of the managed database.
collation?: stringProperty Value
string
createMode
Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required).
createMode?: stringProperty Value
string
creationDate
Creation date of the database. NOTE: This property will not be serialized. It can only be populated by the server.
creationDate?: DateProperty Value
Date
crossSubscriptionRestorableDroppedDatabaseId
The restorable cross-subscription dropped database resource id to restore when creating this database.
crossSubscriptionRestorableDroppedDatabaseId?: stringProperty Value
string
crossSubscriptionSourceDatabaseId
The resource identifier of the cross-subscription source database associated with create operation of this database.
crossSubscriptionSourceDatabaseId?: stringProperty Value
string
crossSubscriptionTargetManagedInstanceId
Target managed instance id used in cross-subscription restore.
crossSubscriptionTargetManagedInstanceId?: stringProperty Value
string
defaultSecondaryLocation
Geo paired region. NOTE: This property will not be serialized. It can only be populated by the server.
defaultSecondaryLocation?: stringProperty Value
string
earliestRestorePoint
Earliest restore point in time for point in time restore. NOTE: This property will not be serialized. It can only be populated by the server.
earliestRestorePoint?: DateProperty Value
Date
failoverGroupId
Instance Failover Group resource identifier that this managed database belongs to. NOTE: This property will not be serialized. It can only be populated by the server.
failoverGroupId?: stringProperty Value
string
lastBackupName
Last backup file name for restore of this managed database.
lastBackupName?: stringProperty Value
string
longTermRetentionBackupResourceId
The name of the Long Term Retention backup to be used for restore of this managed database.
longTermRetentionBackupResourceId?: stringProperty Value
string
recoverableDatabaseId
The resource identifier of the recoverable database associated with create operation of this database.
recoverableDatabaseId?: stringProperty Value
string
restorableDroppedDatabaseId
The restorable dropped database resource id to restore when creating this database.
restorableDroppedDatabaseId?: stringProperty Value
string
restorePointInTime
Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.
restorePointInTime?: DateProperty Value
Date
sourceDatabaseId
The resource identifier of the source database associated with create operation of this database.
sourceDatabaseId?: stringProperty Value
string
status
Status of the database. NOTE: This property will not be serialized. It can only be populated by the server.
status?: stringProperty Value
string
storageContainerIdentity
Conditional. If createMode is RestoreExternalBackup, this value is used. Specifies the identity used for storage container authentication. Can be 'SharedAccessSignature' or 'ManagedIdentity'; if not specified 'SharedAccessSignature' is assumed.
storageContainerIdentity?: stringProperty Value
string
storageContainerSasToken
Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token.
storageContainerSasToken?: stringProperty Value
string
storageContainerUri
Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.
storageContainerUri?: stringProperty Value
string
tags
Resource tags.
tags?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}