ArmCosmosDBModelFactory.CassandraClusterProperties Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
CassandraClusterProperties(Nullable<CassandraProvisioningState>, String, ResourceIdentifier, String, String, Nullable<CassandraAuthenticationMethod>, String, String, Nullable<Boolean>, IEnumerable<CassandraCertificate>, IEnumerable<CassandraCertificate>, IEnumerable<CassandraCertificate>, IEnumerable<CassandraDataCenterSeedNode>, IEnumerable<CassandraDataCenterSeedNode>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>)
- Source:
- ArmCosmosDBModelFactory.cs
public static Azure.ResourceManager.CosmosDB.Models.CassandraClusterProperties CassandraClusterProperties (Azure.ResourceManager.CosmosDB.Models.CassandraProvisioningState? provisioningState = default, string restoreFromBackupId = default, Azure.Core.ResourceIdentifier delegatedManagementSubnetId = default, string cassandraVersion = default, string clusterNameOverride = default, Azure.ResourceManager.CosmosDB.Models.CassandraAuthenticationMethod? authenticationMethod = default, string initialCassandraAdminPassword = default, string prometheusEndpointIPAddress = default, bool? isRepairEnabled = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> clientCertificates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> externalGossipCertificates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> gossipCertificates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraDataCenterSeedNode> externalSeedNodes = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraDataCenterSeedNode> seedNodes = default, int? hoursBetweenBackups = default, bool? isDeallocated = default, bool? isCassandraAuditLoggingEnabled = default);static member CassandraClusterProperties : Nullable<Azure.ResourceManager.CosmosDB.Models.CassandraProvisioningState> * string * Azure.Core.ResourceIdentifier * string * string * Nullable<Azure.ResourceManager.CosmosDB.Models.CassandraAuthenticationMethod> * string * string * Nullable<bool> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraDataCenterSeedNode> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraDataCenterSeedNode> * Nullable<int> * Nullable<bool> * Nullable<bool> -> Azure.ResourceManager.CosmosDB.Models.CassandraClusterPropertiesPublic Shared Function CassandraClusterProperties (Optional provisioningState As Nullable(Of CassandraProvisioningState) = Nothing, Optional restoreFromBackupId As String = Nothing, Optional delegatedManagementSubnetId As ResourceIdentifier = Nothing, Optional cassandraVersion As String = Nothing, Optional clusterNameOverride As String = Nothing, Optional authenticationMethod As Nullable(Of CassandraAuthenticationMethod) = Nothing, Optional initialCassandraAdminPassword As String = Nothing, Optional prometheusEndpointIPAddress As String = Nothing, Optional isRepairEnabled As Nullable(Of Boolean) = Nothing, Optional clientCertificates As IEnumerable(Of CassandraCertificate) = Nothing, Optional externalGossipCertificates As IEnumerable(Of CassandraCertificate) = Nothing, Optional gossipCertificates As IEnumerable(Of CassandraCertificate) = Nothing, Optional externalSeedNodes As IEnumerable(Of CassandraDataCenterSeedNode) = Nothing, Optional seedNodes As IEnumerable(Of CassandraDataCenterSeedNode) = Nothing, Optional hoursBetweenBackups As Nullable(Of Integer) = Nothing, Optional isDeallocated As Nullable(Of Boolean) = Nothing, Optional isCassandraAuditLoggingEnabled As Nullable(Of Boolean) = Nothing) As CassandraClusterPropertiesParameters
- provisioningState
- Nullable<CassandraProvisioningState>
- restoreFromBackupId
- String
- delegatedManagementSubnetId
- ResourceIdentifier
- cassandraVersion
- String
- clusterNameOverride
- String
- authenticationMethod
- Nullable<CassandraAuthenticationMethod>
- initialCassandraAdminPassword
- String
- prometheusEndpointIPAddress
- String
- clientCertificates
- IEnumerable<CassandraCertificate>
- externalGossipCertificates
- IEnumerable<CassandraCertificate>
- gossipCertificates
- IEnumerable<CassandraCertificate>
- externalSeedNodes
- IEnumerable<CassandraDataCenterSeedNode>
- seedNodes
- IEnumerable<CassandraDataCenterSeedNode>
Returns
Applies to
CassandraClusterProperties(Nullable<CassandraProvisioningState>, String, ResourceIdentifier, String, String, Nullable<CassandraAuthenticationMethod>, String, String, Nullable<Boolean>, Nullable<CassandraAutoReplicateForm>, IEnumerable<CassandraCertificate>, IEnumerable<CassandraCertificate>, IEnumerable<CassandraCertificate>, IEnumerable<CassandraDataCenterSeedNode>, IEnumerable<CassandraDataCenterSeedNode>, IEnumerable<String>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Nullable<CassandraClusterType>, CassandraError, IEnumerable<String>, IEnumerable<CassandraClusterBackupSchedule>, Nullable<ScheduledEventStrategy>, Nullable<ServiceConnectionType>, ResourceIdentifier)
- Source:
- ArmCosmosDBModelFactory.cs
Initializes a new instance of CassandraClusterProperties.
public static Azure.ResourceManager.CosmosDB.Models.CassandraClusterProperties CassandraClusterProperties (Azure.ResourceManager.CosmosDB.Models.CassandraProvisioningState? provisioningState = default, string restoreFromBackupId = default, Azure.Core.ResourceIdentifier delegatedManagementSubnetId = default, string cassandraVersion = default, string clusterNameOverride = default, Azure.ResourceManager.CosmosDB.Models.CassandraAuthenticationMethod? authenticationMethod = default, string initialCassandraAdminPassword = default, string prometheusEndpointIPAddress = default, bool? isRepairEnabled = default, Azure.ResourceManager.CosmosDB.Models.CassandraAutoReplicateForm? autoReplicate = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> clientCertificates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> externalGossipCertificates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> gossipCertificates = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraDataCenterSeedNode> externalSeedNodes = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraDataCenterSeedNode> seedNodes = default, System.Collections.Generic.IEnumerable<string> externalDataCenters = default, int? hoursBetweenBackups = default, bool? isDeallocated = default, bool? isCassandraAuditLoggingEnabled = default, Azure.ResourceManager.CosmosDB.Models.CassandraClusterType? clusterType = default, Azure.ResourceManager.CosmosDB.Models.CassandraError provisionError = default, System.Collections.Generic.IEnumerable<string> extensions = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CassandraClusterBackupSchedule> backupSchedules = default, Azure.ResourceManager.CosmosDB.Models.ScheduledEventStrategy? scheduledEventStrategy = default, Azure.ResourceManager.CosmosDB.Models.ServiceConnectionType? azureConnectionMethod = default, Azure.Core.ResourceIdentifier privateLinkResourceId = default);static member CassandraClusterProperties : Nullable<Azure.ResourceManager.CosmosDB.Models.CassandraProvisioningState> * string * Azure.Core.ResourceIdentifier * string * string * Nullable<Azure.ResourceManager.CosmosDB.Models.CassandraAuthenticationMethod> * string * string * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.CassandraAutoReplicateForm> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraCertificate> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraDataCenterSeedNode> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraDataCenterSeedNode> * seq<string> * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.CassandraClusterType> * Azure.ResourceManager.CosmosDB.Models.CassandraError * seq<string> * seq<Azure.ResourceManager.CosmosDB.Models.CassandraClusterBackupSchedule> * Nullable<Azure.ResourceManager.CosmosDB.Models.ScheduledEventStrategy> * Nullable<Azure.ResourceManager.CosmosDB.Models.ServiceConnectionType> * Azure.Core.ResourceIdentifier -> Azure.ResourceManager.CosmosDB.Models.CassandraClusterPropertiesPublic Shared Function CassandraClusterProperties (Optional provisioningState As Nullable(Of CassandraProvisioningState) = Nothing, Optional restoreFromBackupId As String = Nothing, Optional delegatedManagementSubnetId As ResourceIdentifier = Nothing, Optional cassandraVersion As String = Nothing, Optional clusterNameOverride As String = Nothing, Optional authenticationMethod As Nullable(Of CassandraAuthenticationMethod) = Nothing, Optional initialCassandraAdminPassword As String = Nothing, Optional prometheusEndpointIPAddress As String = Nothing, Optional isRepairEnabled As Nullable(Of Boolean) = Nothing, Optional autoReplicate As Nullable(Of CassandraAutoReplicateForm) = Nothing, Optional clientCertificates As IEnumerable(Of CassandraCertificate) = Nothing, Optional externalGossipCertificates As IEnumerable(Of CassandraCertificate) = Nothing, Optional gossipCertificates As IEnumerable(Of CassandraCertificate) = Nothing, Optional externalSeedNodes As IEnumerable(Of CassandraDataCenterSeedNode) = Nothing, Optional seedNodes As IEnumerable(Of CassandraDataCenterSeedNode) = Nothing, Optional externalDataCenters As IEnumerable(Of String) = Nothing, Optional hoursBetweenBackups As Nullable(Of Integer) = Nothing, Optional isDeallocated As Nullable(Of Boolean) = Nothing, Optional isCassandraAuditLoggingEnabled As Nullable(Of Boolean) = Nothing, Optional clusterType As Nullable(Of CassandraClusterType) = Nothing, Optional provisionError As CassandraError = Nothing, Optional extensions As IEnumerable(Of String) = Nothing, Optional backupSchedules As IEnumerable(Of CassandraClusterBackupSchedule) = Nothing, Optional scheduledEventStrategy As Nullable(Of ScheduledEventStrategy) = Nothing, Optional azureConnectionMethod As Nullable(Of ServiceConnectionType) = Nothing, Optional privateLinkResourceId As ResourceIdentifier = Nothing) As CassandraClusterPropertiesParameters
- provisioningState
- Nullable<CassandraProvisioningState>
The status of the resource at the time the operation was called.
- restoreFromBackupId
- 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.
- delegatedManagementSubnetId
- ResourceIdentifier
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>'.
- cassandraVersion
- 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.
- clusterNameOverride
- 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.
- authenticationMethod
- Nullable<CassandraAuthenticationMethod>
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'.
- initialCassandraAdminPassword
- 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'.
- prometheusEndpointIPAddress
- String
Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached.
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.
- autoReplicate
- Nullable<CassandraAutoReplicateForm>
The form of AutoReplicate that is being used by this cluster.
- clientCertificates
- IEnumerable<CassandraCertificate>
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.
- externalGossipCertificates
- IEnumerable<CassandraCertificate>
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.
- gossipCertificates
- IEnumerable<CassandraCertificate>
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.
- externalSeedNodes
- IEnumerable<CassandraDataCenterSeedNode>
List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes.
- seedNodes
- IEnumerable<CassandraDataCenterSeedNode>
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.
- externalDataCenters
- IEnumerable<String>
List of the data center names for unmanaged data centers in this cluster to be included in auto-replication.
(Deprecated) Number of hours to wait between taking a backup of the cluster.
Whether the cluster and associated data centers has been deallocated.
- clusterType
- Nullable<CassandraClusterType>
Type of the cluster. If set to Production, some operations might not be permitted on cluster.
- provisionError
- CassandraError
Error related to resource provisioning.
- extensions
- IEnumerable<String>
Extensions to be added or updated on cluster.
- backupSchedules
- IEnumerable<CassandraClusterBackupSchedule>
List of backup schedules that define when you want to back up your data.
- scheduledEventStrategy
- Nullable<ScheduledEventStrategy>
How the nodes in the cluster react to scheduled events.
- azureConnectionMethod
- Nullable<ServiceConnectionType>
How to connect to the azure services needed for running the cluster.
- privateLinkResourceId
- ResourceIdentifier
If the Connection Method is Vpn, this is the Id of the private link resource that the datacenters need to connect to.
Returns
A new CassandraClusterProperties instance for mocking.
