azure.mgmt.kusto.operations module

class azure.mgmt.kusto.operations.ClustersOperations(client, config, serializer, deserializer)[source]

Bases: object

ClustersOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2017-09-07-privatepreview”.

create_or_update(resource_group_name, cluster_name, location, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update a Kusto cluster.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • location (str) – The geo-location where the resource lives
  • tags (dict[str, str]) – Resource tags.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns:

An instance of LROPoller that returns Cluster or ClientRawResponse<Cluster> if raw==True

Return type:

AzureOperationPoller[Cluster] or AzureOperationPoller[ClientRawResponse[Cluster]]

Raises:

CloudError

delete(resource_group_name, cluster_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Kusto cluster.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns:

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type:

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises:

CloudError

get(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Kusto cluster.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

Cluster or ClientRawResponse if raw=true

Return type:

Cluster or ClientRawResponse

Raises:

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all Kusto clusters within a subscription.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of Cluster

Return type:

ClusterPaged[Cluster]

Raises:

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all Kusto clusters within a resource group.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of Cluster

Return type:

ClusterPaged[Cluster]

Raises:

CloudError

update(resource_group_name, cluster_name, location=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Update a Kusto cluster.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • location (str) – Resource location
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns:

An instance of LROPoller that returns Cluster or ClientRawResponse<Cluster> if raw==True

Return type:

AzureOperationPoller[Cluster] or AzureOperationPoller[ClientRawResponse[Cluster]]

Raises:

CloudError

models = <module 'azure.mgmt.kusto.models' from '/usr/lib/python3/dist-packages/azure/mgmt/kusto/models/__init__.py'>
class azure.mgmt.kusto.operations.DatabasesOperations(client, config, serializer, deserializer)[source]

Bases: object

DatabasesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2017-09-07-privatepreview”.

create_or_update(resource_group_name, cluster_name, database_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a database.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • database_name (str) – The name of the database in the Kusto cluster.
  • parameters (Database) – The database parameters supplied to the CreateOrUpdate operation.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns:

An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True

Return type:

AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]

Raises:

CloudError

delete(resource_group_name, cluster_name, database_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes the database with the given name.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • database_name (str) – The name of the database in the Kusto cluster.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns:

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type:

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises:

CloudError

get(resource_group_name, cluster_name, database_name, custom_headers=None, raw=False, **operation_config)[source]

Returns a database.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • database_name (str) – The name of the database in the Kusto cluster.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

Database or ClientRawResponse if raw=true

Return type:

Database or ClientRawResponse

Raises:

CloudError

list_by_cluster(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

Returns the list of databases of the given Kusto cluster.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of Database

Return type:

DatabasePaged[Database]

Raises:

CloudError

update(resource_group_name, cluster_name, database_name, soft_delete_period_in_days, location=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates a database.

Parameters:
  • resource_group_name (str) – The name of the resource group containing the Kusto cluster.
  • cluster_name (str) – The name of the Kusto cluster.
  • database_name (str) – The name of the database in the Kusto cluster.
  • soft_delete_period_in_days (int) – The number of days data should be kept before it stops being accessible to queries.
  • location (str) – Resource location
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns:

An instance of LROPoller that returns Database or ClientRawResponse<Database> if raw==True

Return type:

AzureOperationPoller[Database] or AzureOperationPoller[ClientRawResponse[Database]]

Raises:

CloudError

models = <module 'azure.mgmt.kusto.models' from '/usr/lib/python3/dist-packages/azure/mgmt/kusto/models/__init__.py'>
class azure.mgmt.kusto.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An object model deserializer.
Variables:

api_version – Client Api Version. Constant value: “2017-09-07-privatepreview”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists available operations for the Microsoft.Kusto provider.

Parameters:
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Returns:

An iterator like instance of Operation

Return type:

OperationPaged[Operation]

Raises:

CloudError

models = <module 'azure.mgmt.kusto.models' from '/usr/lib/python3/dist-packages/azure/mgmt/kusto/models/__init__.py'>