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.object
ClustersOperations

Constructor

ClustersOperations(client, config, serializer, deserializer) -> None

Parameters

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

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_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.

begin_add_language_extensions(resource_group_name: str, cluster_name: str, language_extensions_to_add: azure.mgmt.kusto.models._models_py3.LanguageExtensionsList, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

language_extensions_to_add
LanguageExtensionsList
Required

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

begin_create_or_update

Create or update a Kusto cluster.

begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.kusto.models._models_py3.Cluster, if_match: typing.Union[str, NoneType] = None, if_none_match: typing.Union[str, NoneType] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.Cluster')]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

parameters
Cluster
Required

The Kusto cluster parameters supplied to the CreateOrUpdate operation.

if_match
str
default value: None

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
default value: None

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes a Kusto cluster.

begin_delete(resource_group_name: str, cluster_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

begin_detach_follower_databases

Detaches all followers of a database owned by this cluster.

begin_detach_follower_databases(resource_group_name: str, cluster_name: str, follower_database_to_remove: azure.mgmt.kusto.models._models_py3.FollowerDatabaseDefinition, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

follower_database_to_remove
FollowerDatabaseDefinition
Required

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

begin_diagnose_virtual_network

Diagnoses network connectivity status for external resources on which the service is dependent on.

begin_diagnose_virtual_network(resource_group_name: str, cluster_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.DiagnoseVirtualNetworkResult')]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

begin_remove_language_extensions

Remove a list of language extensions that can run within KQL queries.

begin_remove_language_extensions(resource_group_name: str, cluster_name: str, language_extensions_to_remove: azure.mgmt.kusto.models._models_py3.LanguageExtensionsList, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

language_extensions_to_remove
LanguageExtensionsList
Required

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

begin_start

Starts a Kusto cluster.

begin_start(resource_group_name: str, cluster_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

begin_stop

Stops a Kusto cluster.

begin_stop(resource_group_name: str, cluster_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

begin_update

Update a Kusto cluster.

begin_update(resource_group_name: str, cluster_name: str, parameters: azure.mgmt.kusto.models._models_py3.ClusterUpdate, if_match: typing.Union[str, NoneType] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('_models.Cluster')]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

parameters
ClusterUpdate
Required

The Kusto cluster parameters supplied to the Update operation.

if_match
str
default value: None

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

Pass in True if you'd like the AsyncARMPolling polling method, False for no polling, or 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

~azure.core.exceptions.HttpResponseError

check_name_availability

Checks that the cluster name is valid and is not already in use.

check_name_availability(location: str, cluster_name: azure.mgmt.kusto.models._models_py3.ClusterCheckNameRequest, **kwargs) -> azure.mgmt.kusto.models._models_py3.CheckNameResult

Parameters

location
str
Required

Azure location (region) name.

cluster_name
ClusterCheckNameRequest
Required

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

~azure.core.exceptions.HttpResponseError

get

Gets a Kusto cluster.

get(resource_group_name: str, cluster_name: str, **kwargs) -> azure.mgmt.kusto.models._models_py3.Cluster

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

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

~azure.core.exceptions.HttpResponseError

list

Lists all Kusto clusters within a subscription.

list(**kwargs) -> typing.AsyncIterable[_ForwardRef('_models.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

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Lists all Kusto clusters within a resource group.

list_by_resource_group(resource_group_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('_models.ClusterListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

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

~azure.core.exceptions.HttpResponseError

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) -> typing.AsyncIterable[_ForwardRef('_models.FollowerDatabaseListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

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

~azure.core.exceptions.HttpResponseError

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) -> typing.AsyncIterable[_ForwardRef('_models.LanguageExtensionsList')]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

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

~azure.core.exceptions.HttpResponseError

list_skus

Lists eligible SKUs for Kusto resource provider.

list_skus(**kwargs) -> typing.AsyncIterable[_ForwardRef('_models.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

~azure.core.exceptions.HttpResponseError

list_skus_by_resource

Returns the SKUs available for the provided resource.

list_skus_by_resource(resource_group_name: str, cluster_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('_models.ListResourceSkusResult')]

Parameters

resource_group_name
str
Required

The name of the resource group containing the Kusto cluster.

cluster_name
str
Required

The name of the Kusto cluster.

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

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.kusto.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\kusto\\models\\__init__.py'>