DataConnectionsOperations Class

DataConnectionsOperations 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
DataConnectionsOperations

Constructor

DataConnectionsOperations(client, config, serializer, deserializer)

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_create_or_update

Creates or updates a data connection.

begin_data_connection_validation

Checks that the data connection parameters are valid.

begin_delete

Deletes the data connection with the given name.

begin_update

Updates a data connection.

check_name_availability

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

get

Returns a data connection.

list_by_database

Returns the list of data connections of the given Kusto database.

begin_create_or_update

Creates or updates a data connection.

async begin_create_or_update(resource_group_name: str, cluster_name: str, database_name: str, data_connection_name: str, parameters: azure.mgmt.kusto.models._models_py3.DataConnection, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.DataConnection]

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.

database_name
str
Required

The name of the database in the Kusto cluster.

data_connection_name
str
Required

The name of the data connection.

parameters
<xref:kusto_management_client.models.DataConnection>
Required

The data connection 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 DataConnection or the result of cls(response)

Return type

AsyncLROPoller[<xref:kusto_management_client.models.DataConnection>]

Exceptions

begin_data_connection_validation

Checks that the data connection parameters are valid.

async begin_data_connection_validation(resource_group_name: str, cluster_name: str, database_name: str, parameters: azure.mgmt.kusto.models._models_py3.DataConnectionValidation, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.DataConnectionValidationListResult]

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.

database_name
str
Required

The name of the database in the Kusto cluster.

parameters
<xref:kusto_management_client.models.DataConnectionValidation>
Required

The data connection 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 DataConnectionValidationListResult or the result of cls(response)

Return type

AsyncLROPoller[<xref:kusto_management_client.models.DataConnectionValidationListResult>]

Exceptions

begin_delete

Deletes the data connection with the given name.

async begin_delete(resource_group_name: str, cluster_name: str, database_name: str, data_connection_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

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.

database_name
str
Required

The name of the database in the Kusto cluster.

data_connection_name
str
Required

The name of the data connection.

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 data connection.

async begin_update(resource_group_name: str, cluster_name: str, database_name: str, data_connection_name: str, parameters: azure.mgmt.kusto.models._models_py3.DataConnection, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.kusto.models._models_py3.DataConnection]

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.

database_name
str
Required

The name of the database in the Kusto cluster.

data_connection_name
str
Required

The name of the data connection.

parameters
<xref:kusto_management_client.models.DataConnection>
Required

The data connection 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 DataConnection or the result of cls(response)

Return type

AsyncLROPoller[<xref:kusto_management_client.models.DataConnection>]

Exceptions

check_name_availability

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

async check_name_availability(resource_group_name: str, cluster_name: str, database_name: str, data_connection_name: azure.mgmt.kusto.models._models_py3.DataConnectionCheckNameRequest, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.CheckNameResult

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.

database_name
str
Required

The name of the database in the Kusto cluster.

data_connection_name
<xref:kusto_management_client.models.DataConnectionCheckNameRequest>
Required

The name of the data connection.

cls
callable

A custom type or function that will be passed the direct response

Returns

CheckNameResult, or the result of cls(response)

Return type

<xref:kusto_management_client.models.CheckNameResult>

Exceptions

get

Returns a data connection.

async get(resource_group_name: str, cluster_name: str, database_name: str, data_connection_name: str, **kwargs: Any) -> azure.mgmt.kusto.models._models_py3.DataConnection

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.

database_name
str
Required

The name of the database in the Kusto cluster.

data_connection_name
str
Required

The name of the data connection.

cls
callable

A custom type or function that will be passed the direct response

Returns

DataConnection, or the result of cls(response)

Return type

<xref:kusto_management_client.models.DataConnection>

Exceptions

list_by_database

Returns the list of data connections of the given Kusto database.

list_by_database(resource_group_name: str, cluster_name: str, database_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.kusto.models._models_py3.DataConnectionListResult]

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.

database_name
str
Required

The name of the database in the Kusto cluster.

cls
callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataConnectionListResult or the result of cls(response)

Return type

AsyncItemPaged[<xref:kusto_management_client.models.DataConnectionListResult>]

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'>