cassandra_clusters

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

Overview

Name	cassandra_clusters
Type	Resource
Id	azure.cosmos_db.cassandra_clusters

Fields

Name	Datatype	Description
id	string	The unique resource identifier of the ARM resource.
name	string	The name of the ARM resource.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
properties	object	Properties of a managed Cassandra cluster.
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 Azure resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	clusterName, resourceGroupName, subscriptionId	Get the properties of a managed Cassandra cluster.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List all managed Cassandra clusters in this resource group.
list_by_subscription	SELECT	subscriptionId	List all managed Cassandra clusters in this subscription.
create_update	INSERT	clusterName, resourceGroupName, subscriptionId	Create or update a managed Cassandra cluster. When updating, you must specify all writable properties. To update only some properties, use PATCH.
delete	DELETE	clusterName, resourceGroupName, subscriptionId	Deletes a managed Cassandra cluster.
update	UPDATE	clusterName, resourceGroupName, subscriptionId	Updates some of the properties of a managed Cassandra cluster.
deallocate	EXEC	clusterName, resourceGroupName, subscriptionId	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.
invoke_command	EXEC	clusterName, resourceGroupName, subscriptionId, data__command, data__host	Invoke a command like nodetool for cassandra maintenance
invoke_command_async	EXEC	clusterName, resourceGroupName, subscriptionId, data__command, data__host	Invoke a command like nodetool for cassandra maintenance asynchronously
start	EXEC	clusterName, resourceGroupName, subscriptionId	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	clusterName, resourceGroupName, subscriptionId	Gets the CPU, memory, and disk usage statistics for each Cassandra node in a cluster.

SELECT examples

List all managed Cassandra clusters in this subscription.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.cosmos_db.cassandra_clusters
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new cassandra_clusters resource.

All Properties

/*+ create */
INSERT INTO azure.cosmos_db.cassandra_clusters (
clusterName,
resourceGroupName,
subscriptionId,
location,
tags,
identity,
properties
)
SELECT 
'{{ clusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ identity }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: []
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: restoreFromBackupId
          value: string
        - name: delegatedManagementSubnetId
          value: string
        - name: cassandraVersion
          value: string
        - name: clusterNameOverride
          value: string
        - name: authenticationMethod
          value: string
        - name: initialCassandraAdminPassword
          value: string
        - name: prometheusEndpoint
          value:
            - name: ipAddress
              value: string
        - name: repairEnabled
          value: boolean
        - name: autoReplicate
          value: string
        - name: clientCertificates
          value:
            - - name: pem
                value: string
        - name: externalGossipCertificates
          value:
            - - name: pem
                value: string
        - name: gossipCertificates
          value:
            - - name: pem
                value: string
        - name: externalSeedNodes
          value:
            - - name: ipAddress
                value: string
        - name: seedNodes
          value:
            - - name: ipAddress
                value: string
        - name: externalDataCenters
          value:
            - string
        - name: hoursBetweenBackups
          value: integer
        - name: deallocated
          value: boolean
        - name: cassandraAuditLoggingEnabled
          value: boolean
        - name: clusterType
          value: string
        - name: provisionError
          value:
            - name: code
              value: string
            - name: message
              value: string
            - name: target
              value: string
            - name: additionalErrorInfo
              value: string
        - name: extensions
          value:
            - string
        - name: backupSchedules
          value:
            - - name: scheduleName
                value: string
              - name: cronExpression
                value: string
              - name: retentionInHours
                value: integer
        - name: scheduledEventStrategy
          value: string
        - name: azureConnectionMethod
          value: string
        - name: privateLinkResourceId
          value: string

UPDATE example

Updates a cassandra_clusters resource.

/*+ update */
UPDATE azure.cosmos_db.cassandra_clusters
SET 
location = '{{ location }}',
tags = '{{ tags }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified cassandra_clusters resource.

/*+ delete */
DELETE FROM azure.cosmos_db.cassandra_clusters
WHERE clusterName = '{{ clusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';