Feedback Edit

ManagedDatabase Class

  • Reference

A managed database resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance
azure.mgmt.sql.models._models_py3.TrackedResource
ManagedDatabase

Constructor

ManagedDatabase(*, location: str, tags: Optional[Dict[str, str]] = None, collation: Optional[str] = None, restore_point_in_time: Optional[datetime.datetime] = None, catalog_collation: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.CatalogCollationType]] = None, create_mode: Optional[Union[str, azure.mgmt.sql.models._sql_management_client_enums.ManagedDatabaseCreateMode]] = None, storage_container_uri: Optional[str] = None, source_database_id: Optional[str] = None, restorable_dropped_database_id: Optional[str] = None, storage_container_sas_token: Optional[str] = None, recoverable_database_id: Optional[str] = None, long_term_retention_backup_resource_id: Optional[str] = None, auto_complete_restore: Optional[bool] = None, last_backup_name: Optional[str] = None, **kwargs)

Parameters

location
str
Required

Required. Resource location.

tags
dict[str, str]
Required

A set of tags. Resource tags.

collation
str
Required

Collation of the managed database.

restore_point_in_time
datetime
Required

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.

catalog_collation
str or CatalogCollationType
Required

Collation of the metadata catalog. Possible values include: "DATABASE_DEFAULT", "SQL_Latin1_General_CP1_CI_AS".

create_mode
str or ManagedDatabaseCreateMode
Required

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). Possible values include: "Default", "RestoreExternalBackup", "PointInTimeRestore", "Recovery", "RestoreLongTermRetentionBackup".

storage_container_uri
str
Required

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

source_database_id
str
Required

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

restorable_dropped_database_id
str
Required

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

storage_container_sas_token
str
Required

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

recoverable_database_id
str
Required

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

long_term_retention_backup_resource_id
str
Required

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

auto_complete_restore
bool
Required

Whether to auto complete restore of this managed database.

last_backup_name
str
Required

Last backup file name for restore of this managed database.

Variables

id
str

Resource ID.

name
str

Resource name.

type
str

Resource type.

status
str or ManagedDatabaseStatus

Status of the database. Possible values include: "Online", "Offline", "Shutdown", "Creating", "Inaccessible", "Restoring", "Updating".

creation_date
datetime

Creation date of the database.

earliest_restore_point
datetime

Earliest restore point in time for point in time restore.

default_secondary_location
str

Geo paired region.

failover_group_id
str

Instance Failover Group resource identifier that this managed database belongs to.