ClusterResourceProperties interface

Package:

@azure/arm-cosmosdb

Properties of a managed Cassandra cluster.

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'.
azureConnectionMethod	How to connect to the azure services needed for running the cluster
cassandraAuditLoggingEnabled	Whether Cassandra audit logging is enabled
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.
deallocated	Whether the cluster and associated data centers has been deallocated.
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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'
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. NOTE: This property will not be serialized. It can only be populated by the server.
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'.
privateLinkResourceId	If the Connection Method is VPN, this is the Id of the private link resource that the datacenters need to connect to. NOTE: This property will not be serialized. It can only be populated by the server.
prometheusEndpoint	Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
provisionError	Error related to resource provisioning.
provisioningState	The status of the resource at the time the operation was called.
repairEnabled	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	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	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.

Property Details

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

authenticationMethod?: string

Property Value

string

azureConnectionMethod

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

azureConnectionMethod?: string

Property Value

string

cassandraAuditLoggingEnabled

Whether Cassandra audit logging is enabled

cassandraAuditLoggingEnabled?: boolean

Property Value

boolean

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.

cassandraVersion?: string

Property Value

string

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.

clientCertificates?: Certificate[]

Property Value

Certificate[]

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.

clusterNameOverride?: string

Property Value

string

deallocated

Whether the cluster and associated data centers has been deallocated.

deallocated?: boolean

Property Value

boolean

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

delegatedManagementSubnetId?: string

Property Value

string

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.

externalGossipCertificates?: Certificate[]

Property Value

Certificate[]

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.

externalSeedNodes?: SeedNode[]

Property Value

SeedNode[]

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

gossipCertificates?: Certificate[]

Property Value

Certificate[]

hoursBetweenBackups

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

hoursBetweenBackups?: number

Property Value

number

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

initialCassandraAdminPassword?: string

Property Value

string

privateLinkResourceId

If the Connection Method is VPN, this is the Id of the private link resource that the datacenters need to connect to. NOTE: This property will not be serialized. It can only be populated by the server.

privateLinkResourceId?: string

Property Value

string

prometheusEndpoint

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

prometheusEndpoint?: SeedNode

Property Value

SeedNode

provisionError

Error related to resource provisioning.

provisionError?: CassandraError

Property Value

CassandraError

provisioningState

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

provisioningState?: string

Property Value

string

repairEnabled

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.

repairEnabled?: boolean

Property Value

boolean

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.

restoreFromBackupId?: string

Property Value

string

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

seedNodes?: SeedNode[]

Property Value

SeedNode[]