ManagedDatabasesOperations Class
ManagedDatabasesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectManagedDatabasesOperations
Constructor
ManagedDatabasesOperations(client, config, serializer, deserializer)
Parameters
Name | Description |
---|---|
client
Required
|
Client for service requests. |
config
Required
|
Configuration of service client. |
serializer
Required
|
An object model serializer. |
deserializer
Required
|
An object model deserializer. |
Variables
Name | Description |
---|---|
models
|
Alias to model classes used in this operation group. |
Methods
begin_complete_restore |
Completes the restore operation on a managed database. |
begin_create_or_update |
Creates a new database or updates an existing database. |
begin_delete |
Deletes a managed database. |
begin_update |
Updates an existing database. |
get |
Gets a managed database. |
list_by_instance |
Gets a list of managed databases. |
list_inaccessible_by_instance |
Gets a list of inaccessible managed databases in a managed instance. |
begin_complete_restore
Completes the restore operation on a managed database.
begin_complete_restore(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: '_models.CompleteDatabaseRestoreDefinition', **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
managed_instance_name
Required
|
The name of the managed instance. |
database_name
Required
|
The name of the database. |
parameters
Required
|
The definition for completing the restore of this managed database. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_or_update
Creates a new database or updates an existing database.
begin_create_or_update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: '_models.ManagedDatabase', **kwargs: Any) -> LROPoller['_models.ManagedDatabase']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
managed_instance_name
Required
|
The name of the managed instance. |
database_name
Required
|
The name of the database. |
parameters
Required
|
The requested database resource state. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either ManagedDatabase or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Deletes a managed database.
begin_delete(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
managed_instance_name
Required
|
The name of the managed instance. |
database_name
Required
|
The name of the database. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_update
Updates an existing database.
begin_update(resource_group_name: str, managed_instance_name: str, database_name: str, parameters: '_models.ManagedDatabaseUpdate', **kwargs: Any) -> LROPoller['_models.ManagedDatabase']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
managed_instance_name
Required
|
The name of the managed instance. |
database_name
Required
|
The name of the database. |
parameters
Required
|
The requested database resource state. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either ManagedDatabase or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets a managed database.
get(resource_group_name: str, managed_instance_name: str, database_name: str, **kwargs: Any) -> _models.ManagedDatabase
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
managed_instance_name
Required
|
The name of the managed instance. |
database_name
Required
|
The name of the database. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
ManagedDatabase, or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_by_instance
Gets a list of managed databases.
list_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) -> Iterable['_models.ManagedDatabaseListResult']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
managed_instance_name
Required
|
The name of the managed instance. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either ManagedDatabaseListResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_inaccessible_by_instance
Gets a list of inaccessible managed databases in a managed instance.
list_inaccessible_by_instance(resource_group_name: str, managed_instance_name: str, **kwargs: Any) -> Iterable['_models.ManagedDatabaseListResult']
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. |
managed_instance_name
Required
|
The name of the managed instance. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either ManagedDatabaseListResult or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.sql.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>
Azure SDK for Python