cassandra_clusters

Creates, updates, deletes, gets or lists a cassandra_clusters resource.

Overview

Name	cassandra_clusters
Type	Resource
Id	azure.cosmosdb.cassandra_clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authenticationMethod	string	Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. Known values are: "None", "Cassandra", and "Ldap". (None, Cassandra, Ldap)
autoReplicate	string	The form of AutoReplicate that is being used by this cluster. Known values are: "None", "SystemKeyspaces", and "AllKeyspaces". (None, SystemKeyspaces, AllKeyspaces)
azureConnectionMethod	string	How to connect to the azure services needed for running the cluster. Known values are: "None" and "VPN". (None, VPN)
backupSchedules	array	List of backup schedules that define when you want to back up your data.
cassandraAuditLoggingEnabled	boolean	Whether Cassandra audit logging is enabled.
cassandraVersion	string	Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates	array	List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride	string	If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated	boolean	Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId	string	Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
extensions	array	Extensions to be added or updated on cluster.
externalDataCenters	array	List of the data center names for unmanaged data centers in this cluster to be included in auto-replication.
externalGossipCertificates	array	List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes	array	List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
gossipCertificates	array	List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
hoursBetweenBackups	integer	(Deprecated) Number of hours to wait between taking a backup of the cluster.
identity	object	Identity for the resource.
initialCassandraAdminPassword	string	Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
location	string	The location of the resource group to which the resource belongs.
privateLinkResourceId	string	If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to.
prometheusEndpoint	object	SeedNode.
provisionError	object	Error related to resource provisioning.
provisioningState	string	The status of the resource at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
repairEnabled	boolean	Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
restoreFromBackupId	string	To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
scheduledEventStrategy	string	How the nodes in the cluster react to scheduled events. Known values are: "Ignore", "StopAny", and "StopByRack". (Ignore, StopAny, StopByRack)
seedNodes	array	List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authenticationMethod	string	Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. Known values are: "None", "Cassandra", and "Ldap". (None, Cassandra, Ldap)
autoReplicate	string	The form of AutoReplicate that is being used by this cluster. Known values are: "None", "SystemKeyspaces", and "AllKeyspaces". (None, SystemKeyspaces, AllKeyspaces)
azureConnectionMethod	string	How to connect to the azure services needed for running the cluster. Known values are: "None" and "VPN". (None, VPN)
backupSchedules	array	List of backup schedules that define when you want to back up your data.
cassandraAuditLoggingEnabled	boolean	Whether Cassandra audit logging is enabled.
cassandraVersion	string	Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates	array	List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride	string	If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated	boolean	Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId	string	Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
extensions	array	Extensions to be added or updated on cluster.
externalDataCenters	array	List of the data center names for unmanaged data centers in this cluster to be included in auto-replication.
externalGossipCertificates	array	List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes	array	List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
gossipCertificates	array	List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
hoursBetweenBackups	integer	(Deprecated) Number of hours to wait between taking a backup of the cluster.
identity	object	Identity for the resource.
initialCassandraAdminPassword	string	Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
location	string	The location of the resource group to which the resource belongs.
privateLinkResourceId	string	If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to.
prometheusEndpoint	object	SeedNode.
provisionError	object	Error related to resource provisioning.
provisioningState	string	The status of the resource at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
repairEnabled	boolean	Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
restoreFromBackupId	string	To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
scheduledEventStrategy	string	How the nodes in the cluster react to scheduled events. Known values are: "Ignore", "StopAny", and "StopByRack". (Ignore, StopAny, StopByRack)
seedNodes	array	List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authenticationMethod	string	Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. Known values are: "None", "Cassandra", and "Ldap". (None, Cassandra, Ldap)
autoReplicate	string	The form of AutoReplicate that is being used by this cluster. Known values are: "None", "SystemKeyspaces", and "AllKeyspaces". (None, SystemKeyspaces, AllKeyspaces)
azureConnectionMethod	string	How to connect to the azure services needed for running the cluster. Known values are: "None" and "VPN". (None, VPN)
backupSchedules	array	List of backup schedules that define when you want to back up your data.
cassandraAuditLoggingEnabled	boolean	Whether Cassandra audit logging is enabled.
cassandraVersion	string	Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version.
clientCertificates	array	List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property.
clusterNameOverride	string	If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property.
deallocated	boolean	Whether the cluster and associated data centers has been deallocated.
delegatedManagementSubnetId	string	Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
extensions	array	Extensions to be added or updated on cluster.
externalDataCenters	array	List of the data center names for unmanaged data centers in this cluster to be included in auto-replication.
externalGossipCertificates	array	List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property.
externalSeedNodes	array	List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
gossipCertificates	array	List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property.
hoursBetweenBackups	integer	(Deprecated) Number of hours to wait between taking a backup of the cluster.
identity	object	Identity for the resource.
initialCassandraAdminPassword	string	Initial password for clients connecting as admin to the cluster. Should be changed after cluster creation. Returns null on GET. This field only applies when the authenticationMethod field is 'Cassandra'.
location	string	The location of the resource group to which the resource belongs.
privateLinkResourceId	string	If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to.
prometheusEndpoint	object	SeedNode.
provisionError	object	Error related to resource provisioning.
provisioningState	string	The status of the resource at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
repairEnabled	boolean	Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs.
restoreFromBackupId	string	To create an empty cluster, omit this field or set it to null. To restore a backup into a new cluster, set this field to the resource id of the backup.
scheduledEventStrategy	string	How the nodes in the cluster react to scheduled events. Known values are: "Ignore", "StopAny", and "StopByRack". (Ignore, StopAny, StopByRack)
seedNodes	array	List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, subscription_id		Get the properties of a managed Cassandra cluster.
list_by_resource_group	select	resource_group_name, subscription_id		List all managed Cassandra clusters in this resource group.
list_by_subscription	select	subscription_id		List all managed Cassandra clusters in this subscription.
create_update	insert	resource_group_name, cluster_name, subscription_id		Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
update	update	resource_group_name, cluster_name, subscription_id		Updates some of the properties of a managed Cassandra cluster.
create_update	replace	resource_group_name, cluster_name, subscription_id		Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
delete	delete	resource_group_name, cluster_name, subscription_id		Deletes a managed Cassandra cluster.
invoke_command	exec	resource_group_name, cluster_name, subscription_id, command, host		Invoke a command like nodetool for cassandra maintenance.
deallocate	exec	resource_group_name, cluster_name, subscription_id	x-ms-force-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.
start	exec	resource_group_name, cluster_name, subscription_id		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.
status	exec	resource_group_name, cluster_name, subscription_id		Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	Managed Cassandra cluster name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
x-ms-force-deallocate	string	Force to deallocate a cluster of Cluster Type Production. Force to deallocate a cluster of Cluster Type Production might cause data loss. Default value is None.

SELECT examples

get

Get the properties of a managed Cassandra cluster.

SELECT
id,
name,
authenticationMethod,
autoReplicate,
azureConnectionMethod,
backupSchedules,
cassandraAuditLoggingEnabled,
cassandraVersion,
clientCertificates,
clusterNameOverride,
deallocated,
delegatedManagementSubnetId,
extensions,
externalDataCenters,
externalGossipCertificates,
externalSeedNodes,
gossipCertificates,
hoursBetweenBackups,
identity,
initialCassandraAdminPassword,
location,
privateLinkResourceId,
prometheusEndpoint,
provisionError,
provisioningState,
repairEnabled,
restoreFromBackupId,
scheduledEventStrategy,
seedNodes,
systemData,
tags,
type
FROM azure.cosmosdb.cassandra_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all managed Cassandra clusters in this resource group.

SELECT
id,
name,
authenticationMethod,
autoReplicate,
azureConnectionMethod,
backupSchedules,
cassandraAuditLoggingEnabled,
cassandraVersion,
clientCertificates,
clusterNameOverride,
deallocated,
delegatedManagementSubnetId,
extensions,
externalDataCenters,
externalGossipCertificates,
externalSeedNodes,
gossipCertificates,
hoursBetweenBackups,
identity,
initialCassandraAdminPassword,
location,
privateLinkResourceId,
prometheusEndpoint,
provisionError,
provisioningState,
repairEnabled,
restoreFromBackupId,
scheduledEventStrategy,
seedNodes,
systemData,
tags,
type
FROM azure.cosmosdb.cassandra_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all managed Cassandra clusters in this subscription.

SELECT
id,
name,
authenticationMethod,
autoReplicate,
azureConnectionMethod,
backupSchedules,
cassandraAuditLoggingEnabled,
cassandraVersion,
clientCertificates,
clusterNameOverride,
deallocated,
delegatedManagementSubnetId,
extensions,
externalDataCenters,
externalGossipCertificates,
externalSeedNodes,
gossipCertificates,
hoursBetweenBackups,
identity,
initialCassandraAdminPassword,
location,
privateLinkResourceId,
prometheusEndpoint,
provisionError,
provisioningState,
repairEnabled,
restoreFromBackupId,
scheduledEventStrategy,
seedNodes,
systemData,
tags,
type
FROM azure.cosmosdb.cassandra_clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_update

Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.

INSERT INTO azure.cosmosdb.cassandra_clusters (
properties,
location,
tags,
identity,
resource_group_name,
cluster_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: cassandra_clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cassandra_clusters resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the cassandra_clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cassandra_clusters resource.
  - name: properties
    description: |
      Properties of a managed Cassandra cluster.
    value:
      provisioningState: "{{ provisioningState }}"
      restoreFromBackupId: "{{ restoreFromBackupId }}"
      delegatedManagementSubnetId: "{{ delegatedManagementSubnetId }}"
      cassandraVersion: "{{ cassandraVersion }}"
      clusterNameOverride: "{{ clusterNameOverride }}"
      authenticationMethod: "{{ authenticationMethod }}"
      initialCassandraAdminPassword: "{{ initialCassandraAdminPassword }}"
      prometheusEndpoint:
        ipAddress: "{{ ipAddress }}"
      repairEnabled: {{ repairEnabled }}
      autoReplicate: "{{ autoReplicate }}"
      clientCertificates:
        - pem: "{{ pem }}"
      externalGossipCertificates:
        - pem: "{{ pem }}"
      gossipCertificates:
        - pem: "{{ pem }}"
      externalSeedNodes:
        - ipAddress: "{{ ipAddress }}"
      seedNodes:
        - ipAddress: "{{ ipAddress }}"
      externalDataCenters:
        - "{{ externalDataCenters }}"
      hoursBetweenBackups: {{ hoursBetweenBackups }}
      deallocated: {{ deallocated }}
      cassandraAuditLoggingEnabled: {{ cassandraAuditLoggingEnabled }}
      provisionError:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        additionalErrorInfo: "{{ additionalErrorInfo }}"
      extensions:
        - "{{ extensions }}"
      backupSchedules:
        - scheduleName: "{{ scheduleName }}"
          cronExpression: "{{ cronExpression }}"
          retentionInHours: {{ retentionInHours }}
      scheduledEventStrategy: "{{ scheduledEventStrategy }}"
      azureConnectionMethod: "{{ azureConnectionMethod }}"
      privateLinkResourceId: "{{ privateLinkResourceId }}"
  - name: location
    value: "{{ location }}"
    description: |
      The location of the resource group to which the resource belongs.
  - name: tags
    value: "{{ tags }}"
    description: |
      Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
  - name: identity
    description: |
      Identity for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"

UPDATE examples

update

Updates some of the properties of a managed Cassandra cluster.

UPDATE azure.cosmosdb.cassandra_clusters
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_update

Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.

REPLACE azure.cosmosdb.cassandra_clusters
SET 
properties = '{{ properties }}',
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a managed Cassandra cluster.

DELETE FROM azure.cosmosdb.cassandra_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

invoke_command

Invoke a command like nodetool for cassandra maintenance.

EXEC azure.cosmosdb.cassandra_clusters.invoke_command 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"command": "{{ command }}", 
"arguments": "{{ arguments }}", 
"host": "{{ host }}", 
"cassandra-stop-start": {{ cassandra-stop-start }}, 
"readwrite": {{ readwrite }}
}'
;

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.

EXEC azure.cosmosdb.cassandra_clusters.deallocate 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@x-ms-force-deallocate='{{ x-ms-force-deallocate }}'
;

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.

EXEC azure.cosmosdb.cassandra_clusters.start 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

status

Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.

EXEC azure.cosmosdb.cassandra_clusters.status 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_name='{{ cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;