DatabasesOperations Class
DatabasesOperations async 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
| add_principals |
Add Database principals permissions. |
| begin_create_or_update |
Creates or updates a database. |
| begin_delete |
Deletes the database with the given name. |
| begin_update |
Updates a database. |
| check_name_availability |
Checks that the databases resource name is valid and is not already in use. |
| get |
Returns a database. |
| list_by_cluster |
Returns the list of databases of the given Kusto cluster. |
| list_principals |
Returns a list of database principals of the given Kusto cluster and database. |
| remove_principals |
Remove Database principals permissions. |
add_principals
Add Database principals permissions.
async add_principals(resource_group_name: str, cluster_name: str, database_name: str, database_principals_to_add: azure.mgmt.kusto.models._models_py3.DatabasePrincipalListRequest, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.DatabasePrincipalListResultParameters
- database_principals_to_add
- <xref:kusto_management_client.models.DatabasePrincipalListRequest>
List of database principals to add.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
DatabasePrincipalListResult, or the result of cls(response)
Return type
Exceptions
begin_create_or_update
Creates or updates a database.
async begin_create_or_update(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.kusto.models._models_py3.Database, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.Database]Parameters
- parameters
- <xref:kusto_management_client.models.Database>
The database parameters supplied to the CreateOrUpdate operation.
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either Database or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes the database with the given name.
async begin_delete(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_update
Updates a database.
async begin_update(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.kusto.models._models_py3.Database, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.Database]Parameters
- parameters
- <xref:kusto_management_client.models.Database>
The database parameters supplied to the Update operation.
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either Database or the result of cls(response)
Return type
Exceptions
check_name_availability
Checks that the databases resource name is valid and is not already in use.
async check_name_availability(resource_group_name: str, cluster_name: str, resource_name: azure.mgmt.kusto.models._models_py3.CheckNameRequest, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.CheckNameResultParameters
- resource_name
- <xref:kusto_management_client.models.CheckNameRequest>
The name of the resource.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
CheckNameResult, or the result of cls(response)
Return type
Exceptions
get
Returns a database.
async get(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) -> azure.mgmt.kusto.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
Returns the list of databases of the given Kusto cluster.
list_by_cluster(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.DatabaseListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either DatabaseListResult or the result of cls(response)
Return type
Exceptions
list_principals
Returns a list of database principals of the given Kusto cluster and database.
list_principals(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.DatabasePrincipalListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either DatabasePrincipalListResult or the result of cls(response)
Return type
Exceptions
remove_principals
Remove Database principals permissions.
async remove_principals(resource_group_name: str, cluster_name: str, database_name: str, database_principals_to_remove: azure.mgmt.kusto.models._models_py3.DatabasePrincipalListRequest, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.DatabasePrincipalListResultParameters
- database_principals_to_remove
- <xref:kusto_management_client.models.DatabasePrincipalListRequest>
List of database principals to remove.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
DatabasePrincipalListResult, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.kusto.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\kusto\\models\\__init__.py'>Feedback
Submit and view feedback for