AttachedDatabaseConfigurationsOperations Class

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

Constructor

AttachedDatabaseConfigurationsOperations(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 an attached database configuration.

begin_delete

Deletes the attached database configuration with the given name.

check_name_availability

Checks that the attached database configuration resource name is valid and is not already in use.

get

Returns an attached database configuration.

list_by_cluster

Returns the list of attached database configurations of the given Kusto cluster.

begin_create_or_update

Creates or updates an attached database configuration.

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

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.

attached_database_configuration_name
str
Required

The name of the attached database configuration.

parameters
<xref:kusto_management_client.models.AttachedDatabaseConfiguration>
Required

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 AttachedDatabaseConfiguration or the result of cls(response)

Return type

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

Exceptions

begin_delete

Deletes the attached database configuration with the given name.

async begin_delete(resource_group_name: str, cluster_name: str, attached_database_configuration_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.

attached_database_configuration_name
str
Required

The name of the attached database configuration.

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

check_name_availability

Checks that the attached database configuration 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.AttachedDatabaseConfigurationsCheckNameRequest, **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.

resource_name
<xref:kusto_management_client.models.AttachedDatabaseConfigurationsCheckNameRequest>
Required

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

<xref:kusto_management_client.models.CheckNameResult>

Exceptions

get

Returns an attached database configuration.

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

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.

attached_database_configuration_name
str
Required

The name of the attached database configuration.

cls
callable

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

Returns

AttachedDatabaseConfiguration, or the result of cls(response)

Return type

<xref:kusto_management_client.models.AttachedDatabaseConfiguration>

Exceptions

list_by_cluster

Returns the list of attached database configurations of the given Kusto cluster.

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

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 AttachedDatabaseConfigurationListResult or the result of cls(response)

Return type

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

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