ClustersOperations Class
ClustersOperations 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.objectClustersOperations
Constructor
ClustersOperations(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_add_language_extensions |
Add a list of language extensions that can run within KQL queries. |
| begin_create_or_update |
Create or update a Kusto cluster. |
| begin_delete |
Deletes a Kusto cluster. |
| begin_detach_follower_databases |
Detaches all followers of a database owned by this cluster. |
| begin_diagnose_virtual_network |
Diagnoses network connectivity status for external resources on which the service is dependent on. |
| begin_remove_language_extensions |
Remove a list of language extensions that can run within KQL queries. |
| begin_start |
Starts a Kusto cluster. |
| begin_stop |
Stops a Kusto cluster. |
| begin_update |
Update a Kusto cluster. |
| check_name_availability |
Checks that the cluster name is valid and is not already in use. |
| get |
Gets a Kusto cluster. |
| list |
Lists all Kusto clusters within a subscription. |
| list_by_resource_group |
Lists all Kusto clusters within a resource group. |
| list_follower_databases |
Returns a list of databases that are owned by this cluster and were followed by another cluster. |
| list_language_extensions |
Returns a list of language extensions that can run within KQL queries. |
| list_outbound_network_dependencies_endpoints |
Gets the network endpoints of all outbound dependencies of a Kusto cluster. |
| list_skus |
Lists eligible SKUs for Kusto resource provider. |
| list_skus_by_resource |
Returns the SKUs available for the provided resource. |
begin_add_language_extensions
Add a list of language extensions that can run within KQL queries.
async begin_add_language_extensions(resource_group_name: str, cluster_name: str, language_extensions_to_add: azure.mgmt.kusto.models._models_py3.LanguageExtensionsList, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- language_extensions_to_add
- <xref:kusto_management_client.models.LanguageExtensionsList>
The language extensions to add.
- 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_create_or_update
Create or update a Kusto cluster.
async begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.kusto.models._models_py3.Cluster, if_match: Optional[str] = None, if_none_match: Optional[str] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.Cluster]Parameters
- parameters
- <xref:kusto_management_client.models.Cluster>
The Kusto cluster parameters supplied to the CreateOrUpdate operation.
- if_match
- str
The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
- if_none_match
- str
Set to '*' to allow a new cluster to be created, but to prevent updating an existing cluster. Other values will result in a 412 Pre-condition Failed response.
- 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 Cluster or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes a Kusto cluster.
async begin_delete(resource_group_name: str, cluster_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_detach_follower_databases
Detaches all followers of a database owned by this cluster.
async begin_detach_follower_databases(resource_group_name: str, cluster_name: str, follower_database_to_remove: azure.mgmt.kusto.models._models_py3.FollowerDatabaseDefinition, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- follower_database_to_remove
- <xref:kusto_management_client.models.FollowerDatabaseDefinition>
The follower databases properties to remove.
- 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_diagnose_virtual_network
Diagnoses network connectivity status for external resources on which the service is dependent on.
async begin_diagnose_virtual_network(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.DiagnoseVirtualNetworkResult]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 DiagnoseVirtualNetworkResult or the result of cls(response)
Return type
Exceptions
begin_remove_language_extensions
Remove a list of language extensions that can run within KQL queries.
async begin_remove_language_extensions(resource_group_name: str, cluster_name: str, language_extensions_to_remove: azure.mgmt.kusto.models._models_py3.LanguageExtensionsList, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- language_extensions_to_remove
- <xref:kusto_management_client.models.LanguageExtensionsList>
The language extensions to remove.
- 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_start
Starts a Kusto cluster.
async begin_start(resource_group_name: str, cluster_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_stop
Stops a Kusto cluster.
async begin_stop(resource_group_name: str, cluster_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
Update a Kusto cluster.
async begin_update(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.kusto.models._models_py3.ClusterUpdate, if_match: Optional[str] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.Cluster]Parameters
- parameters
- <xref:kusto_management_client.models.ClusterUpdate>
The Kusto cluster parameters supplied to the Update operation.
- if_match
- str
The ETag of the cluster. Omit this value to always overwrite the current cluster. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
- 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 Cluster or the result of cls(response)
Return type
Exceptions
check_name_availability
Checks that the cluster name is valid and is not already in use.
async check_name_availability(location: str, cluster_name: azure.mgmt.kusto.models._models_py3.ClusterCheckNameRequest, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.CheckNameResultParameters
- cluster_name
- <xref:kusto_management_client.models.ClusterCheckNameRequest>
The name of the cluster.
- 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
Gets a Kusto cluster.
async get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.ClusterParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Cluster, or the result of cls(response)
Return type
Exceptions
list
Lists all Kusto clusters within a subscription.
list(**kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.ClusterListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ClusterListResult or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Lists all Kusto clusters within a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.ClusterListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ClusterListResult or the result of cls(response)
Return type
Exceptions
list_follower_databases
Returns a list of databases that are owned by this cluster and were followed by another cluster.
list_follower_databases(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.FollowerDatabaseListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either FollowerDatabaseListResult or the result of cls(response)
Return type
Exceptions
list_language_extensions
Returns a list of language extensions that can run within KQL queries.
list_language_extensions(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.LanguageExtensionsList]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LanguageExtensionsList or the result of cls(response)
Return type
Exceptions
list_outbound_network_dependencies_endpoints
Gets the network endpoints of all outbound dependencies of a Kusto cluster.
list_outbound_network_dependencies_endpoints(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.OutboundNetworkDependenciesEndpointListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either OutboundNetworkDependenciesEndpointListResult or the result of cls(response)
Return type
Exceptions
list_skus
Lists eligible SKUs for Kusto resource provider.
list_skus(**kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.SkuDescriptionList]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either SkuDescriptionList or the result of cls(response)
Return type
Exceptions
list_skus_by_resource
Returns the SKUs available for the provided resource.
list_skus_by_resource(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.ListResourceSkusResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ListResourceSkusResult 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