Share via

ManagedDatabase interface

  • Reference
Package:
@azure/arm-sql

A managed database resource.

Extends
TrackedResource

Properties

autoCompleteRestore

Whether to auto complete restore of this managed database.
catalogCollation

Collation of the metadata catalog.
collation

Collation of the managed database.
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).
creationDate

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

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

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

Target managed instance id used in cross-subscription restore.
defaultSecondaryLocation

Geo paired region. NOTE: This property will not be serialized. It can only be populated by the server.
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.
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.
lastBackupName

Last backup file name for restore of this managed database.
longTermRetentionBackupResourceId

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

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

The restorable dropped database resource id to restore when creating this database.
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.
sourceDatabaseId

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

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

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

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

autoCompleteRestore

Whether to auto complete restore of this managed database.

autoCompleteRestore?: boolean

Property Value

boolean

catalogCollation

Collation of the metadata catalog.

catalogCollation?: string

Property Value

string

collation

Collation of the managed database.

collation?: string

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

Property Value

string

creationDate

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

creationDate?: Date

Property Value

Date

crossSubscriptionRestorableDroppedDatabaseId

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

crossSubscriptionRestorableDroppedDatabaseId?: string

Property Value

string

crossSubscriptionSourceDatabaseId

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

crossSubscriptionSourceDatabaseId?: string

Property Value

string

crossSubscriptionTargetManagedInstanceId

Target managed instance id used in cross-subscription restore.

crossSubscriptionTargetManagedInstanceId?: string

Property Value

string

defaultSecondaryLocation

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

defaultSecondaryLocation?: string

Property 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?: Date

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

Property Value

string

lastBackupName

Last backup file name for restore of this managed database.

lastBackupName?: string

Property Value

string

longTermRetentionBackupResourceId

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

longTermRetentionBackupResourceId?: string

Property Value

string

recoverableDatabaseId

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

recoverableDatabaseId?: string

Property Value

string

restorableDroppedDatabaseId

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

restorableDroppedDatabaseId?: string

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

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

status?: string

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

Property Value

string

storageContainerSasToken

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

storageContainerSasToken?: string

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

Property Value

string

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From TrackedResource.id

location

Resource location.

location: string

Property Value

string

Inherited From TrackedResource.location

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type