CassandraResourcesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CosmosDBManagementClient's

<xref:cassandra_resources> attribute.

Inheritance

builtins.object

CassandraResourcesOperations

Constructor

CassandraResourcesOperations(*args, **kwargs)

Methods

begin_create_update_cassandra_keyspace	Create or update an Azure Cosmos DB Cassandra keyspace.
begin_create_update_cassandra_table	Create or update an Azure Cosmos DB Cassandra Table.
begin_delete_cassandra_keyspace	Deletes an existing Azure Cosmos DB Cassandra keyspace.
begin_delete_cassandra_table	Deletes an existing Azure Cosmos DB Cassandra table.
begin_migrate_cassandra_keyspace_to_autoscale	Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale.
begin_migrate_cassandra_keyspace_to_manual_throughput	Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput.
begin_migrate_cassandra_table_to_autoscale	Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale.
begin_migrate_cassandra_table_to_manual_throughput	Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput.
begin_update_cassandra_keyspace_throughput	Update RUs per second of an Azure Cosmos DB Cassandra Keyspace.
begin_update_cassandra_table_throughput	Update RUs per second of an Azure Cosmos DB Cassandra table.
get_cassandra_keyspace	Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.
get_cassandra_keyspace_throughput	Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.
get_cassandra_table	Gets the Cassandra table under an existing Azure Cosmos DB database account.
get_cassandra_table_throughput	Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.
list_cassandra_keyspaces	Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.
list_cassandra_tables	Lists the Cassandra table under an existing Azure Cosmos DB database account.

begin_create_update_cassandra_keyspace

Create or update an Azure Cosmos DB Cassandra keyspace.

async begin_create_update_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, create_update_cassandra_keyspace_parameters: _models.CassandraKeyspaceCreateUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.CassandraKeyspaceGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
create_update_cassandra_keyspace_parameters Required	CassandraKeyspaceCreateUpdateParameters or IO[bytes] The parameters to provide for the current Cassandra keyspace. Is either a CassandraKeyspaceCreateUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[CassandraKeyspaceGetResults]	An instance of AsyncLROPoller that returns either CassandraKeyspaceGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_create_update_cassandra_table

Create or update an Azure Cosmos DB Cassandra Table.

async begin_create_update_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, create_update_cassandra_table_parameters: _models.CassandraTableCreateUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.CassandraTableGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
table_name Required	str Cosmos DB table name. Required.
create_update_cassandra_table_parameters Required	CassandraTableCreateUpdateParameters or IO[bytes] The parameters to provide for the current Cassandra Table. Is either a CassandraTableCreateUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[CassandraTableGetResults]	An instance of AsyncLROPoller that returns either CassandraTableGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_cassandra_keyspace

Deletes an existing Azure Cosmos DB Cassandra keyspace.

async begin_delete_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete_cassandra_table

Deletes an existing Azure Cosmos DB Cassandra table.

async begin_delete_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_cassandra_keyspace_to_autoscale

Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale.

async begin_migrate_cassandra_keyspace_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_cassandra_keyspace_to_manual_throughput

Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput.

async begin_migrate_cassandra_keyspace_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_cassandra_table_to_autoscale

Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale.

async begin_migrate_cassandra_table_to_autoscale(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_migrate_cassandra_table_to_manual_throughput

Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput.

async begin_migrate_cassandra_table_to_manual_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) -> AsyncLROPoller[ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_cassandra_keyspace_throughput

Update RUs per second of an Azure Cosmos DB Cassandra Keyspace.

async begin_update_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
update_throughput_parameters Required	ThroughputSettingsUpdateParameters or IO[bytes] The RUs per second of the parameters to provide for the current Cassandra Keyspace. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update_cassandra_table_throughput

Update RUs per second of an Azure Cosmos DB Cassandra table.

async begin_update_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, update_throughput_parameters: _models.ThroughputSettingsUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ThroughputSettingsGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
table_name Required	str Cosmos DB table name. Required.
update_throughput_parameters Required	ThroughputSettingsUpdateParameters or IO[bytes] The RUs per second of the parameters to provide for the current Cassandra table. Is either a ThroughputSettingsUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[ThroughputSettingsGetResults]	An instance of AsyncLROPoller that returns either ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_cassandra_keyspace

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.

async get_cassandra_keyspace(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) -> CassandraKeyspaceGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.

Returns

Type	Description
CassandraKeyspaceGetResults	CassandraKeyspaceGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_cassandra_keyspace_throughput

Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.

async get_cassandra_keyspace_throughput(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) -> ThroughputSettingsGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.

Returns

Type	Description
ThroughputSettingsGetResults	ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_cassandra_table

Gets the Cassandra table under an existing Azure Cosmos DB database account.

async get_cassandra_table(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) -> CassandraTableGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
CassandraTableGetResults	CassandraTableGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_cassandra_table_throughput

Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.

async get_cassandra_table_throughput(resource_group_name: str, account_name: str, keyspace_name: str, table_name: str, **kwargs: Any) -> ThroughputSettingsGetResults

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.
table_name Required	str Cosmos DB table name. Required.

Returns

Type	Description
ThroughputSettingsGetResults	ThroughputSettingsGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_cassandra_keyspaces

Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.

list_cassandra_keyspaces(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[CassandraKeyspaceGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.

Returns

Type	Description
AsyncItemPaged[CassandraKeyspaceGetResults]	An iterator like instance of either CassandraKeyspaceGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_cassandra_tables

Lists the Cassandra table under an existing Azure Cosmos DB database account.

list_cassandra_tables(resource_group_name: str, account_name: str, keyspace_name: str, **kwargs: Any) -> AsyncIterable[CassandraTableGetResults]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
account_name Required	str Cosmos DB database account name. Required.
keyspace_name Required	str Cosmos DB keyspace name. Required.

Returns

Type	Description
AsyncItemPaged[CassandraTableGetResults]	An iterator like instance of either CassandraTableGetResults or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cosmosdb.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cosmosdb\\models\\__init__.py'>