documentdb.azure.com/v20251015
APIVersion
| Value | Description |
|---|---|
| “2025-10-15” |
CassandraCluster
Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/managedCassandra.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
Used by: CassandraClusterList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | CassandraCluster_Spec Optional |
|
| status | CassandraCluster_STATUS Optional |
CassandraCluster_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| identity | Identity for the resource. | ManagedCassandraManagedServiceIdentity Optional |
| location | The location of the resource group to which the resource belongs. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | CassandraClusterOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties | Properties of a managed Cassandra cluster. | CassandraCluster_Properties_Spec Optional |
| tags | map[string]string Optional |
CassandraCluster_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | The unique resource identifier of the ARM resource. | string Optional |
| identity | Identity for the resource. | ManagedCassandraManagedServiceIdentity_STATUS Optional |
| location | The location of the resource group to which the resource belongs. | string Optional |
| name | The name of the ARM resource. | string Optional |
| properties | Properties of a managed Cassandra cluster. | CassandraCluster_Properties_STATUS Optional |
| tags | map[string]string Optional |
|
| type | The type of Azure resource. | string Optional |
CassandraClusterList
Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/managedCassandra.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | CassandraCluster[] Optional |
CassandraDataCenter
Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/managedCassandra.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
Used by: CassandraDataCenterList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | CassandraDataCenter_Spec Optional |
|
| status | CassandraDataCenter_STATUS Optional |
CassandraDataCenter_Spec
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | CassandraDataCenterOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/CassandraCluster resource | genruntime.KnownResourceReference Required |
| properties | Properties of a managed Cassandra data center. | CassandraClusters_DataCenter_Properties_Spec Optional |
CassandraDataCenter_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | The unique resource identifier of the database account. | string Optional |
| name | The name of the database account. | string Optional |
| properties | Properties of a managed Cassandra data center. | CassandraClusters_DataCenter_Properties_STATUS Optional |
| type | The type of Azure resource. | string Optional |
CassandraDataCenterList
Generator information: - Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/managedCassandra.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/cassandraClusters/{clusterName}/dataCenters/{dataCenterName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | CassandraDataCenter[] Optional |
CassandraCluster_Spec
Used by: CassandraCluster.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| identity | Identity for the resource. | ManagedCassandraManagedServiceIdentity Optional |
| location | The location of the resource group to which the resource belongs. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | CassandraClusterOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource | genruntime.KnownResourceReference Required |
| properties | Properties of a managed Cassandra cluster. | CassandraCluster_Properties_Spec Optional |
| tags | map[string]string Optional |
CassandraCluster_STATUS
Used by: CassandraCluster.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | The unique resource identifier of the ARM resource. | string Optional |
| identity | Identity for the resource. | ManagedCassandraManagedServiceIdentity_STATUS Optional |
| location | The location of the resource group to which the resource belongs. | string Optional |
| name | The name of the ARM resource. | string Optional |
| properties | Properties of a managed Cassandra cluster. | CassandraCluster_Properties_STATUS Optional |
| tags | map[string]string Optional |
|
| type | The type of Azure resource. | string Optional |
CassandraDataCenter_Spec
Used by: CassandraDataCenter.
| Property | Description | Type |
|---|---|---|
| azureName | The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | CassandraDataCenterOperatorSpec Optional |
| owner | The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a documentdb.azure.com/CassandraCluster resource | genruntime.KnownResourceReference Required |
| properties | Properties of a managed Cassandra data center. | CassandraClusters_DataCenter_Properties_Spec Optional |
CassandraDataCenter_STATUS
Used by: CassandraDataCenter.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| id | The unique resource identifier of the database account. | string Optional |
| name | The name of the database account. | string Optional |
| properties | Properties of a managed Cassandra data center. | CassandraClusters_DataCenter_Properties_STATUS Optional |
| type | The type of Azure resource. | string Optional |
CassandraCluster_Properties_Spec
Used by: CassandraCluster_Spec.
| Property | Description | Type |
|---|---|---|
| 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. |
CassandraCluster_Properties_AuthenticationMethod_Spec Optional |
| azureConnectionMethod | How to connect to the azure services needed for running the cluster | CassandraCluster_Properties_AzureConnectionMethod_Spec Optional |
| cassandraAuditLoggingEnabled | Whether Cassandra audit logging is enabled | bool Optional |
| 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. | string Optional |
| 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. | Certificate[] Optional |
| 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. | string Optional |
| delegatedManagementSubnetReference | 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/ |
genruntime.ResourceReference Optional |
| 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. | Certificate[] Optional |
| 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. | SeedNode[] Optional |
| hoursBetweenBackups | (Deprecated) Number of hours to wait between taking a backup of the cluster. | int Optional |
| 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. |
genruntime.SecretReference Optional |
| prometheusEndpoint | Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. | SeedNode Optional |
| 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. | bool Optional |
| restoreFromBackupReference | 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. | genruntime.ResourceReference Optional |
CassandraCluster_Properties_STATUS
Used by: CassandraCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| 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. |
CassandraCluster_Properties_AuthenticationMethod_STATUS Optional |
| azureConnectionMethod | How to connect to the azure services needed for running the cluster | CassandraCluster_Properties_AzureConnectionMethod_STATUS Optional |
| cassandraAuditLoggingEnabled | Whether Cassandra audit logging is enabled | bool Optional |
| 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. | string Optional |
| 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. | Certificate_STATUS[] Optional |
| 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. | string Optional |
| deallocated | Whether the cluster and associated data centers has been deallocated. | bool Optional |
| 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/ |
string Optional |
| 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. | Certificate_STATUS[] Optional |
| 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. | SeedNode_STATUS[] Optional |
| 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. | Certificate_STATUS[] Optional |
| hoursBetweenBackups | (Deprecated) Number of hours to wait between taking a backup of the cluster. | int Optional |
| privateLinkResourceId | If the Connection Method is VPN, this is the Id of the private link resource that the datacenters need to connect to. | string Optional |
| prometheusEndpoint | Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. | SeedNode_STATUS Optional |
| provisionError | Error related to resource provisioning. | CassandraError_STATUS Optional |
| provisioningState | The status of the resource at the time the operation was called. | ManagedCassandraProvisioningState_STATUS Optional |
| 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. | bool Optional |
| 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. | string Optional |
| 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. | SeedNode_STATUS[] Optional |
CassandraClusterOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: CassandraCluster_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
CassandraClusters_DataCenter_Properties_Spec
Used by: CassandraDataCenter_Spec.
| Property | Description | Type |
|---|---|---|
| authenticationMethodLdapProperties | Ldap authentication method properties. This feature is in preview. | AuthenticationMethodLdapProperties Optional |
| availabilityZone | If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. | bool Optional |
| backupStorageCustomerKeyUri | Indicates the Key Uri of the customer key to use for encryption of the backup storage account. | string Optional |
| backupStorageCustomerKeyUriFromConfig | Indicates the Key Uri of the customer key to use for encryption of the backup storage account. | genruntime.ConfigMapReference Optional |
| base64EncodedCassandraYamlFragment | A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. | string Optional |
| dataCenterLocation | The region this data center should be created in. | string Optional |
| delegatedSubnetReference | Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in dataCenterLocation and must be able to route to the subnet specified in the cluster’s delegatedManagementSubnetId property. This resource id will be of the form ‘/subscriptions/ |
genruntime.ResourceReference Optional |
| diskCapacity | Number of disks attached to each node. Default is 4. | int Optional |
| diskSku | Disk SKU used for data centers. Default value is P30. | string Optional |
| managedDiskCustomerKeyUriReference | Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. | genruntime.ResourceReference Optional |
| nodeCount | The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. | int Optional |
| privateEndpointIpAddress | Ip of the VPN Endpoint for this data center. | string Optional |
| privateEndpointIpAddressFromConfig | Ip of the VPN Endpoint for this data center. | genruntime.ConfigMapReference Optional |
| sku | Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 | string Optional |
CassandraClusters_DataCenter_Properties_STATUS
Used by: CassandraDataCenter_STATUS.
| Property | Description | Type |
|---|---|---|
| authenticationMethodLdapProperties | Ldap authentication method properties. This feature is in preview. | AuthenticationMethodLdapProperties_STATUS Optional |
| availabilityZone | If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. | bool Optional |
| backupStorageCustomerKeyUri | Indicates the Key Uri of the customer key to use for encryption of the backup storage account. | string Optional |
| base64EncodedCassandraYamlFragment | A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. | string Optional |
| dataCenterLocation | The region this data center should be created in. | string Optional |
| deallocated | Whether the data center has been deallocated. | bool Optional |
| delegatedSubnetId | Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in dataCenterLocation and must be able to route to the subnet specified in the cluster’s delegatedManagementSubnetId property. This resource id will be of the form ‘/subscriptions/ |
string Optional |
| diskCapacity | Number of disks attached to each node. Default is 4. | int Optional |
| diskSku | Disk SKU used for data centers. Default value is P30. | string Optional |
| managedDiskCustomerKeyUri | Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. | string Optional |
| nodeCount | The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. | int Optional |
| privateEndpointIpAddress | Ip of the VPN Endpoint for this data center. | string Optional |
| provisionError | Error related to resource provisioning. | CassandraError_STATUS Optional |
| provisioningState | The status of the resource at the time the operation was called. | ManagedCassandraProvisioningState_STATUS Optional |
| seedNodes | IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. | SeedNode_STATUS[] Optional |
| sku | Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 | string Optional |
CassandraDataCenterOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: CassandraDataCenter_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ManagedCassandraManagedServiceIdentity
Identity for the resource.
Used by: CassandraCluster_Spec.
| Property | Description | Type |
|---|---|---|
| type | The type of the resource. | ManagedCassandraManagedServiceIdentity_Type Optional |
ManagedCassandraManagedServiceIdentity_STATUS
Identity for the resource.
Used by: CassandraCluster_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The object id of the identity resource. | string Optional |
| tenantId | The tenant id of the resource. | string Optional |
| type | The type of the resource. | ManagedCassandraManagedServiceIdentity_Type_STATUS Optional |
AuthenticationMethodLdapProperties
Ldap authentication method properties. This feature is in preview.
Used by: CassandraClusters_DataCenter_Properties_Spec.
| Property | Description | Type |
|---|---|---|
| connectionTimeoutInMs | Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. | int Optional |
| searchBaseDistinguishedName | Distinguished name of the object to start the recursive search of users from. | string Optional |
| searchFilterTemplate | Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. | string Optional |
| serverCertificates | Certificate[] Optional |
|
| serverHostname | Hostname of the LDAP server. | string Optional |
| serverPort | Port of the LDAP server. | int Optional |
| serviceUserDistinguishedName | Distinguished name of the look up user account, who can look up user details on authentication. | string Optional |
| serviceUserPassword | Password of the look up user. | genruntime.SecretReference Optional |
AuthenticationMethodLdapProperties_STATUS
Ldap authentication method properties. This feature is in preview.
Used by: CassandraClusters_DataCenter_Properties_STATUS.
| Property | Description | Type |
|---|---|---|
| connectionTimeoutInMs | Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. | int Optional |
| searchBaseDistinguishedName | Distinguished name of the object to start the recursive search of users from. | string Optional |
| searchFilterTemplate | Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. | string Optional |
| serverCertificates | Certificate_STATUS[] Optional |
|
| serverHostname | Hostname of the LDAP server. | string Optional |
| serverPort | Port of the LDAP server. | int Optional |
| serviceUserDistinguishedName | Distinguished name of the look up user account, who can look up user details on authentication. | string Optional |
CassandraCluster_Properties_AuthenticationMethod_Spec
Used by: CassandraCluster_Properties_Spec.
| Value | Description |
|---|---|
| “Cassandra” | |
| “Ldap” | |
| “None” |
CassandraCluster_Properties_AuthenticationMethod_STATUS
Used by: CassandraCluster_Properties_STATUS.
| Value | Description |
|---|---|
| “Cassandra” | |
| “Ldap” | |
| “None” |
CassandraCluster_Properties_AzureConnectionMethod_Spec
Used by: CassandraCluster_Properties_Spec.
| Value | Description |
|---|---|
| “None” | |
| “VPN” |
CassandraCluster_Properties_AzureConnectionMethod_STATUS
Used by: CassandraCluster_Properties_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “VPN” |
CassandraError_STATUS
Used by: CassandraCluster_Properties_STATUS, and CassandraClusters_DataCenter_Properties_STATUS.
| Property | Description | Type |
|---|---|---|
| additionalErrorInfo | Additional information about the error. | string Optional |
| code | The code of error that occurred. | string Optional |
| message | The message of the error. | string Optional |
| target | The target resource of the error. | string Optional |
Certificate
Used by: AuthenticationMethodLdapProperties, CassandraCluster_Properties_Spec, and CassandraCluster_Properties_Spec.
| Property | Description | Type |
|---|---|---|
| pem | PEM formatted public key. | genruntime.SecretReference Optional |
ManagedCassandraManagedServiceIdentity_Type
Used by: ManagedCassandraManagedServiceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” |
ManagedCassandraManagedServiceIdentity_Type_STATUS
Used by: ManagedCassandraManagedServiceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” |
ManagedCassandraProvisioningState_STATUS
The status of the resource at the time the operation was called.
Used by: CassandraCluster_Properties_STATUS, and CassandraClusters_DataCenter_Properties_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
SeedNode
Used by: CassandraCluster_Properties_Spec, and CassandraCluster_Properties_Spec.
| Property | Description | Type |
|---|---|---|
| ipAddress | IP address of this seed node. | string Optional |
| ipAddressFromConfig | IP address of this seed node. | genruntime.ConfigMapReference Optional |
SeedNode_STATUS
Used by: CassandraCluster_Properties_STATUS, CassandraCluster_Properties_STATUS, CassandraCluster_Properties_STATUS, and CassandraClusters_DataCenter_Properties_STATUS.
| Property | Description | Type |
|---|---|---|
| ipAddress | IP address of this seed node. | string Optional |