Package version:

Interface ManagedDatabaseUpdate

An managed database update.

Hierarchy

  • ManagedDatabaseUpdate

Properties

autoCompleteRestore? catalogCollation? collation? createMode? creationDate? crossSubscriptionRestorableDroppedDatabaseId? crossSubscriptionSourceDatabaseId? crossSubscriptionTargetManagedInstanceId? defaultSecondaryLocation? earliestRestorePoint? failoverGroupId? lastBackupName? longTermRetentionBackupResourceId? recoverableDatabaseId? restorableDroppedDatabaseId? restorePointInTime? sourceDatabaseId? status? storageContainerIdentity? storageContainerSasToken? storageContainerUri? tags?

Properties

Optional autoCompleteRestore

autoCompleteRestore?: boolean

Whether to auto complete restore of this managed database.

Optional catalogCollation

catalogCollation?: string

Collation of the metadata catalog.

Optional collation

collation?: string

Collation of the managed database.

Optional createMode

createMode?: string

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).

Optional Readonly creationDate

creationDate?: Date

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

Optional crossSubscriptionRestorableDroppedDatabaseId

crossSubscriptionRestorableDroppedDatabaseId?: string

The restorable cross-subscription dropped database resource id to restore when creating this database.

Optional crossSubscriptionSourceDatabaseId

crossSubscriptionSourceDatabaseId?: string

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

Optional crossSubscriptionTargetManagedInstanceId

crossSubscriptionTargetManagedInstanceId?: string

Target managed instance id used in cross-subscription restore.

Optional Readonly defaultSecondaryLocation

defaultSecondaryLocation?: string

Geo paired region. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonly earliestRestorePoint

earliestRestorePoint?: Date

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.

Optional Readonly failoverGroupId

failoverGroupId?: string

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.

Optional lastBackupName

lastBackupName?: string

Last backup file name for restore of this managed database.

Optional longTermRetentionBackupResourceId

longTermRetentionBackupResourceId?: string

The name of the Long Term Retention backup to be used for restore of this managed database.

Optional recoverableDatabaseId

recoverableDatabaseId?: string

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

Optional restorableDroppedDatabaseId

restorableDroppedDatabaseId?: string

The restorable dropped database resource id to restore when creating this database.

Optional restorePointInTime

restorePointInTime?: Date

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.

Optional sourceDatabaseId

sourceDatabaseId?: string

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

Optional Readonly status

status?: string

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

Optional storageContainerIdentity

storageContainerIdentity?: string

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.

Optional storageContainerSasToken

storageContainerSasToken?: string

Conditional. If createMode is RestoreExternalBackup and storageContainerIdentity is not ManagedIdentity, this value is required. Specifies the storage container sas token.

Optional storageContainerUri

storageContainerUri?: string

Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.

Optional tags

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

Resource tags.

Type declaration

  • [propertyName: string]: string

Settings

Member Visibility

Theme

Generated using TypeDoc