cassandra_clusters_commands

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

Overview

Name	cassandra_clusters_commands
Type	Resource
Id	azure.cosmos_db.cassandra_clusters_commands

Fields

The following fields are returned by SELECT queries:

list

Successfully retrieved the list of shell commands.

Name	Datatype	Description
arguments	object	The arguments for the command to be run
cassandraStopStart	boolean	If true, stops cassandra before executing the command and then start it again
command	string	The command which should be run
commandId	string	The unique id of command
host	string	IP address of the cassandra host to run the command on
isAdmin	boolean	Whether command has admin privileges
outputFile	string	The name of the file where the result is written.
readWrite	boolean	If true, allows the command to write to the cassandra directory, otherwise read-only.
result	string	Result output of the command.
status	string	Status of the command.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, resourceGroupName, clusterName		List all commands currently running on ring info

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
clusterName	string	Managed Cassandra cluster name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

list

List all commands currently running on ring info

SELECT
arguments,
cassandraStopStart,
command,
commandId,
host,
isAdmin,
outputFile,
readWrite,
result,
status
FROM azure.cosmos_db.cassandra_clusters_commands
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;