CassandraClusterProperties Class

Definition

Properties of a managed Cassandra cluster.

public class CassandraClusterProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDB.Models.CassandraClusterProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDB.Models.CassandraClusterProperties>
type CassandraClusterProperties = class
    interface IJsonModel<CassandraClusterProperties>
    interface IPersistableModel<CassandraClusterProperties>
Public Class CassandraClusterProperties
Implements IJsonModel(Of CassandraClusterProperties), IPersistableModel(Of CassandraClusterProperties)
Inheritance
CassandraClusterProperties
Implements

Constructors

CassandraClusterProperties()

Initializes a new instance of CassandraClusterProperties.

Properties

AuthenticationMethod

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'.

AutoReplicate

The form of AutoReplicate that is being used by this cluster.

AzureConnectionMethod

How to connect to the azure services needed for running the cluster.

BackupSchedules

List of backup schedules that define when you want to back up your data.

CassandraVersion

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

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

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.

ClusterType

Type of the cluster. If set to Production, some operations might not be permitted on cluster.

DelegatedManagementSubnetId

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/<subscription id>/resourceGroups/<resource group>/providers/Microsoft.Network/virtualNetworks/<virtual network>/subnets/<subnet>'.

Extensions

Extensions to be added or updated on cluster.

ExternalDataCenters

List of the data center names for unmanaged data centers in this cluster to be included in auto-replication.

ExternalGossipCertificates

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

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

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

(Deprecated) Number of hours to wait between taking a backup of the cluster.

InitialCassandraAdminPassword

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'.

IsCassandraAuditLoggingEnabled

Whether Cassandra audit logging is enabled.

IsDeallocated

Whether the cluster and associated data centers has been deallocated.

IsRepairEnabled

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.

PrivateLinkResourceId

If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to.

PrometheusEndpointIPAddress

IP address of this seed node.

ProvisionError

Error related to resource provisioning.

ProvisioningState

The status of the resource at the time the operation was called.

RestoreFromBackupId

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

How the nodes in the cluster react to scheduled events.

SeedNodes

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.

Explicit Interface Implementations

IJsonModel<CassandraClusterProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CassandraClusterProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CassandraClusterProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CassandraClusterProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CassandraClusterProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to