Share via


ClusterResourceProperties Class

Definition

Properties of a managed Cassandra cluster.

public class ClusterResourceProperties
type ClusterResourceProperties = class
Public Class ClusterResourceProperties
Inheritance
ClusterResourceProperties

Constructors

ClusterResourceProperties()

Initializes a new instance of the ClusterResourceProperties class.

ClusterResourceProperties(String, String, String, String, String, String, String, SeedNode, Nullable<Boolean>, IList<Certificate>, IList<Certificate>, IList<Certificate>, IList<SeedNode>, IList<SeedNode>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>)

Initializes a new instance of the ClusterResourceProperties class.

Properties

AuthenticationMethod

Gets or sets 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'. Possible values include: 'None', 'Cassandra'

CassandraAuditLoggingEnabled

Gets or sets whether Cassandra audit logging is enabled

CassandraVersion

Gets or sets 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

Gets or sets 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

Gets or sets 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

Gets or sets whether the cluster and associated data centers has been deallocated.

DelegatedManagementSubnetId

Gets or sets 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/&lt;subscription id&gt;/resourceGroups/&lt;resource group&gt;/providers/Microsoft.Network/virtualNetworks/&lt;virtual network&gt;/subnets/&lt;subnet&gt;'

ExternalGossipCertificates

Gets or sets 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

Gets or sets 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

Gets 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

Gets or sets number of hours to wait between taking a backup of the cluster. To disable backups, set this property to 0.

InitialCassandraAdminPassword

Gets or sets 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'.

PrometheusEndpoint

Gets or sets hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.

ProvisioningState

Gets or sets possible values include: 'Creating', 'Updating', 'Deleting', 'Succeeded', 'Failed', 'Canceled'

RepairEnabled

Gets or sets 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

Gets or sets 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.

SeedNodes

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

Applies to