CassandraClustersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:cassandra_clusters> attribute.
- Inheritance
-
builtins.objectCassandraClustersOperations
Constructor
CassandraClustersOperations(*args, **kwargs)Methods
| begin_create_update |
Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH. |
| begin_deallocate |
Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster. |
| begin_delete |
Deletes a managed Cassandra cluster. |
| begin_invoke_command |
Invoke a command like nodetool for cassandra maintenance. |
| begin_start |
Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster. |
| begin_update |
Updates some of the properties of a managed Cassandra cluster. |
| get |
Get the properties of a managed Cassandra cluster. |
| list_by_resource_group |
List all managed Cassandra clusters in this resource group. |
| list_by_subscription |
List all managed Cassandra clusters in this subscription. |
| status |
Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster. |
begin_create_update
Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
async begin_create_update(resource_group_name: str, cluster_name: str, body: _models.ClusterResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ClusterResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
Managed Cassandra cluster name. Required. |
|
body
Required
|
The properties specifying the desired state of the managed Cassandra cluster. Is either a ClusterResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either ClusterResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_deallocate
Deallocate the Managed Cassandra Cluster and Associated Data Centers. Deallocation will deallocate the host virtual machine of this cluster, and reserved the data disk. This won't do anything on an already deallocated cluster. Use Start to restart the cluster.
async begin_deallocate(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
Managed Cassandra cluster name. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes a managed Cassandra cluster.
async begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
Managed Cassandra cluster name. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_invoke_command
Invoke a command like nodetool for cassandra maintenance.
async begin_invoke_command(resource_group_name: str, cluster_name: str, body: _models.CommandPostBody, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.CommandOutput]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
Managed Cassandra cluster name. Required. |
|
body
Required
|
Specification which command to run where. Is either a CommandPostBody type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either CommandOutput or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_start
Start the Managed Cassandra Cluster and Associated Data Centers. Start will start the host virtual machine of this cluster with reserved data disk. This won't do anything on an already running cluster. Use Deallocate to deallocate the cluster.
async begin_start(resource_group_name: str, cluster_name: str, **kwargs: Any) -> AsyncLROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
Managed Cassandra cluster name. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_update
Updates some of the properties of a managed Cassandra cluster.
async begin_update(resource_group_name: str, cluster_name: str, body: _models.ClusterResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.ClusterResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
Managed Cassandra cluster name. Required. |
|
body
Required
|
Parameters to provide for specifying the managed Cassandra cluster. Is either a ClusterResource type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either ClusterResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get the properties of a managed Cassandra cluster.
async get(resource_group_name: str, cluster_name: str, **kwargs: Any) -> ClusterResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
Managed Cassandra cluster name. Required. |
Returns
| Type | Description |
|---|---|
|
ClusterResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_resource_group
List all managed Cassandra clusters in this resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[ClusterResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ClusterResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_subscription
List all managed Cassandra clusters in this subscription.
list_by_subscription(**kwargs: Any) -> AsyncIterable[ClusterResource]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ClusterResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
status
Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.
async status(resource_group_name: str, cluster_name: str, **kwargs: Any) -> CassandraClusterPublicStatusParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
cluster_name
Required
|
Managed Cassandra cluster name. Required. |
Returns
| Type | Description |
|---|---|
|
CassandraClusterPublicStatus or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for