Cosmos Database Accounts Cassandra Cluster

This table represents the Cosmos Database Accounts Cassandra Cluster resource from Microsoft Azure.

azure.document_db_database_accounts_cassandra_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
authentication_methodcorestringWhich 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'.
azure_connection_methodcorestringHow to connect to the azure services needed for running the cluster
cassandra_audit_logging_enabledcoreboolWhether Cassandra audit logging is enabled
cassandra_versioncorestringWhich 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.
client_certificatescorejsonList 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.
cluster_name_overridecorestringIf 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.
deallocatedcoreboolWhether the cluster and associated data centers has been deallocated.
delegated_management_subnet_idcorestringResource 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/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'
external_gossip_certificatescorejsonList 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.
external_seed_nodescorejsonList of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
gossip_certificatescorejsonList 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.
hours_between_backupscoreint64(Deprecated) Number of hours to wait between taking a backup of the cluster.
idcorestringThe unique resource identifier of the ARM resource.
identitycorejson
initial_cassandra_admin_passwordcorestringInitial 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'.
locationcorestringThe location of the resource group to which the resource belongs.
namecorestringThe name of the ARM resource.
private_link_resource_idcorestringIf the Connection Method is VPN, this is the Id of the private link resource that the datacenters need to connect to.
prometheus_endpointcorejsonHostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provision_errorcorejsonError related to resource provisioning.
provisioning_statecorestring
repair_enabledcoreboolShould 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.
resource_groupcorestring
restore_from_backup_idcorestringTo 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.
seed_nodescorejsonList of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes.
subscription_idcorestring
subscription_namecorestring
tagscorehstore
typecorestringThe type of Azure resource.