DatabasesOperations Class
DatabasesOperations 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.objectDatabasesOperations
Constructor
DatabasesOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_create |
Creates a database. |
| begin_delete |
Deletes a single database. |
| begin_export |
Exports a database file from target database. |
| begin_force_unlink |
Forcibly removes the link to the specified database resource. |
| begin_import_method |
Imports database files to target database. |
| begin_regenerate_key |
Regenerates the RedisEnterprise database's access keys. |
| begin_update |
Updates a database. |
| get |
Gets information about a database in a RedisEnterprise cluster. |
| list_by_cluster |
Gets all databases in the specified RedisEnterprise cluster. |
| list_keys |
Retrieves the access keys for the RedisEnterprise database. |
begin_create
Creates a database.
begin_create(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.redisenterprise.models._models_py3.Database, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.redisenterprise.models._models_py3.Database]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
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
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Database or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes a single database.
begin_delete(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
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
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_export
Exports a database file from target database.
begin_export(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.redisenterprise.models._models_py3.ExportClusterParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
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
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_force_unlink
Forcibly removes the link to the specified database resource.
begin_force_unlink(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.redisenterprise.models._models_py3.ForceUnlinkParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
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
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_import_method
Imports database files to target database.
begin_import_method(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.redisenterprise.models._models_py3.ImportClusterParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
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
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_regenerate_key
Regenerates the RedisEnterprise database's access keys.
begin_regenerate_key(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.redisenterprise.models._models_py3.RegenerateKeyParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.redisenterprise.models._models_py3.AccessKeys]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
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
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either AccessKeys or the result of cls(response)
Return type
Exceptions
begin_update
Updates a database.
begin_update(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.redisenterprise.models._models_py3.DatabaseUpdate, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.redisenterprise.models._models_py3.Database]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
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
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Database or the result of cls(response)
Return type
Exceptions
get
Gets information about a database in a RedisEnterprise cluster.
get(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) -> azure.mgmt.redisenterprise.models._models_py3.DatabaseParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Database, or the result of cls(response)
Return type
Exceptions
list_by_cluster
Gets all databases in the specified RedisEnterprise cluster.
list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) -> Iterable[azure.mgmt.redisenterprise.models._models_py3.DatabaseList]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either DatabaseList or the result of cls(response)
Return type
Exceptions
list_keys
Retrieves the access keys for the RedisEnterprise database.
list_keys(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) -> azure.mgmt.redisenterprise.models._models_py3.AccessKeysParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AccessKeys, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.redisenterprise.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\redisenterprise\\models\\__init__.py'>Feedback
Submit and view feedback for