Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClusterResourceProperties

Package version

Properties of a managed Cassandra cluster.

Hierarchy

  • ClusterResourceProperties

Index

Properties

Optional authenticationMethod

authenticationMethod: 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'. 'Ldap' is in preview.

Optional cassandraAuditLoggingEnabled

cassandraAuditLoggingEnabled: undefined | false | true

Whether Cassandra audit logging is enabled

Optional cassandraVersion

cassandraVersion: undefined | string

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.

Optional clientCertificates

clientCertificates: Certificate[]

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.

Optional clusterNameOverride

clusterNameOverride: undefined | string

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.

Optional deallocated

deallocated: undefined | false | true

Whether the cluster and associated data centers has been deallocated.

Optional delegatedManagementSubnetId

delegatedManagementSubnetId: undefined | string

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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'

Optional externalGossipCertificates

externalGossipCertificates: Certificate[]

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.

Optional externalSeedNodes

externalSeedNodes: SeedNode[]

List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.

Optional gossipCertificates

gossipCertificates: Certificate[]

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. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hoursBetweenBackups

hoursBetweenBackups: undefined | number

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

Optional initialCassandraAdminPassword

initialCassandraAdminPassword: undefined | string

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

Optional prometheusEndpoint

prometheusEndpoint: SeedNode

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

Optional provisioningState

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

Optional repairEnabled

repairEnabled: undefined | false | true

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.

Optional restoreFromBackupId

restoreFromBackupId: undefined | string

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.

Optional seedNodes

seedNodes: SeedNode[]

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. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc