ManagedDatabase Class
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.TrackedResourceManagedDatabase
Constructor
ManagedDatabase(*, location: str, tags: Dict[str, str] | None = None, collation: str | None = None, restore_point_in_time: datetime | None = None, catalog_collation: str | CatalogCollationType | None = None, create_mode: str | ManagedDatabaseCreateMode | None = None, storage_container_uri: str | None = None, source_database_id: str | None = None, restorable_dropped_database_id: str | None = None, storage_container_sas_token: str | None = None, recoverable_database_id: str | None = None, long_term_retention_backup_resource_id: str | None = None, auto_complete_restore: bool | None = None, last_backup_name: str | None = None, **kwargs)
Parameters
Name | Description |
---|---|
location
Required
|
Required. Resource location. |
tags
Required
|
A set of tags. Resource tags. |
collation
Required
|
Collation of the managed database. |
restore_point_in_time
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
Required
|
Collation of the metadata catalog. Possible values include: "DATABASE_DEFAULT", "SQL_Latin1_General_CP1_CI_AS". |
create_mode
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
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
Required
|
The resource identifier of the source database associated with create operation of this database. |
restorable_dropped_database_id
Required
|
The restorable dropped database resource id to restore when creating this database. |
storage_container_sas_token
Required
|
Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token. |
recoverable_database_id
Required
|
The resource identifier of the recoverable database associated with create operation of this database. |
long_term_retention_backup_resource_id
Required
|
The name of the Long Term Retention backup to be used for restore of this managed database. |
auto_complete_restore
Required
|
Whether to auto complete restore of this managed database. |
last_backup_name
Required
|
Last backup file name for restore of this managed database. |
Keyword-Only Parameters
Name | Description |
---|---|
location
Required
|
|
tags
Required
|
|
collation
Required
|
|
restore_point_in_time
Required
|
|
catalog_collation
Required
|
|
create_mode
Required
|
|
storage_container_uri
Required
|
|
source_database_id
Required
|
|
restorable_dropped_database_id
Required
|
|
storage_container_sas_token
Required
|
|
recoverable_database_id
Required
|
|
long_term_retention_backup_resource_id
Required
|
|
auto_complete_restore
Required
|
|
last_backup_name
Required
|
|
Variables
Name | Description |
---|---|
id
|
Resource ID. |
name
|
Resource name. |
type
|
Resource type. |
status
|
Status of the database. Possible values include: "Online", "Offline", "Shutdown", "Creating", "Inaccessible", "Restoring", "Updating". |
creation_date
|
Creation date of the database. |
earliest_restore_point
|
Earliest restore point in time for point in time restore. |
default_secondary_location
|
Geo paired region. |
failover_group_id
|
Instance Failover Group resource identifier that this managed database belongs to. |
Azure SDK for Python