Share via

DataCenterResourceProperties Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.DataCenterResourceProperties

Implements

JsonSerializable<DataCenterResourceProperties>

public final class DataCenterResourceProperties
implements JsonSerializable<DataCenterResourceProperties>

Properties of a managed Cassandra data center.

Constructor Summary

Constructor Description
DataCenterResourceProperties()

Creates an instance of DataCenterResourceProperties class.

Method Summary

Modifier and Type Method and Description
AuthenticationMethodLdapProperties authenticationMethodLdapProperties()

Get the authenticationMethodLdapProperties property: Ldap authentication method properties.
Boolean availabilityZone()

Get the availabilityZone property: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
String backupStorageCustomerKeyUri()

Get the backupStorageCustomerKeyUri property: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
String base64EncodedCassandraYamlFragment()

Get the base64EncodedCassandraYamlFragment property: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center.
String dataCenterLocation()

Get the dataCenterLocation property: The region this data center should be created in.
Boolean deallocated()

Get the deallocated property: Whether the data center has been deallocated.
String delegatedSubnetId()

Get the delegatedSubnetId property: Resource id of a subnet the nodes in this data center should have their network interfaces connected to.
Integer diskCapacity()

Get the diskCapacity property: Number of disks attached to each node.
String diskSku()

Get the diskSku property: Disk SKU used for data centers.
static DataCenterResourceProperties fromJson(JsonReader jsonReader)

Reads an instance of DataCenterResourceProperties from the JsonReader.
String managedDiskCustomerKeyUri()

Get the managedDiskCustomerKeyUri property: Key uri to use for encryption of managed disks.
Integer nodeCount()

Get the nodeCount property: The number of nodes the data center should have.
String privateEndpointIpAddress()

Get the privateEndpointIpAddress property: Ip of the VPN Endpoint for this data center.
CassandraError provisionError()

Get the provisionError property: Error related to resource provisioning.
ManagedCassandraProvisioningState provisioningState()

Get the provisioningState property: The status of the resource at the time the operation was called.
List<SeedNode> seedNodes()

Get the seedNodes property: IP addresses for seed nodes in this data center.
String sku()

Get the sku property: Virtual Machine SKU used for data centers.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
DataCenterResourceProperties withAuthenticationMethodLdapProperties(AuthenticationMethodLdapProperties authenticationMethodLdapProperties)

Set the authenticationMethodLdapProperties property: Ldap authentication method properties.
DataCenterResourceProperties withAvailabilityZone(Boolean availabilityZone)

Set the availabilityZone property: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
DataCenterResourceProperties withBackupStorageCustomerKeyUri(String backupStorageCustomerKeyUri)

Set the backupStorageCustomerKeyUri property: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
DataCenterResourceProperties withBase64EncodedCassandraYamlFragment(String base64EncodedCassandraYamlFragment)

Set the base64EncodedCassandraYamlFragment property: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center.
DataCenterResourceProperties withDataCenterLocation(String dataCenterLocation)

Set the dataCenterLocation property: The region this data center should be created in.
DataCenterResourceProperties withDeallocated(Boolean deallocated)

Set the deallocated property: Whether the data center has been deallocated.
DataCenterResourceProperties withDelegatedSubnetId(String delegatedSubnetId)

Set the delegatedSubnetId property: Resource id of a subnet the nodes in this data center should have their network interfaces connected to.
DataCenterResourceProperties withDiskCapacity(Integer diskCapacity)

Set the diskCapacity property: Number of disks attached to each node.
DataCenterResourceProperties withDiskSku(String diskSku)

Set the diskSku property: Disk SKU used for data centers.
DataCenterResourceProperties withManagedDiskCustomerKeyUri(String managedDiskCustomerKeyUri)

Set the managedDiskCustomerKeyUri property: Key uri to use for encryption of managed disks.
DataCenterResourceProperties withNodeCount(Integer nodeCount)

Set the nodeCount property: The number of nodes the data center should have.
DataCenterResourceProperties withPrivateEndpointIpAddress(String privateEndpointIpAddress)

Set the privateEndpointIpAddress property: Ip of the VPN Endpoint for this data center.
DataCenterResourceProperties withProvisionError(CassandraError provisionError)

Set the provisionError property: Error related to resource provisioning.
DataCenterResourceProperties withProvisioningState(ManagedCassandraProvisioningState provisioningState)

Set the provisioningState property: The status of the resource at the time the operation was called.
DataCenterResourceProperties withSku(String sku)

Set the sku property: Virtual Machine SKU used for data centers.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataCenterResourceProperties

public DataCenterResourceProperties()

Creates an instance of DataCenterResourceProperties class.

Method Details

authenticationMethodLdapProperties

public AuthenticationMethodLdapProperties authenticationMethodLdapProperties()

Get the authenticationMethodLdapProperties property: Ldap authentication method properties. This feature is in preview.

Returns:

the authenticationMethodLdapProperties value.

availabilityZone

public Boolean availabilityZone()

Get the availabilityZone property: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.

Returns:

the availabilityZone value.

backupStorageCustomerKeyUri

public String backupStorageCustomerKeyUri()

Get the backupStorageCustomerKeyUri property: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.

Returns:

the backupStorageCustomerKeyUri value.

base64EncodedCassandraYamlFragment

public String base64EncodedCassandraYamlFragment()

Get the base64EncodedCassandraYamlFragment property: 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.

Returns:

the base64EncodedCassandraYamlFragment value.

dataCenterLocation

public String dataCenterLocation()

Get the dataCenterLocation property: The region this data center should be created in.

Returns:

the dataCenterLocation value.

deallocated

public Boolean deallocated()

Get the deallocated property: Whether the data center has been deallocated.

Returns:

the deallocated value.

delegatedSubnetId

public String delegatedSubnetId()

Get the delegatedSubnetId property: 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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.

Returns:

the delegatedSubnetId value.

diskCapacity

public Integer diskCapacity()

Get the diskCapacity property: Number of disks attached to each node. Default is 4.

Returns:

the diskCapacity value.

diskSku

public String diskSku()

Get the diskSku property: Disk SKU used for data centers. Default value is P30.

Returns:

the diskSku value.

fromJson

public static DataCenterResourceProperties fromJson(JsonReader jsonReader)

Reads an instance of DataCenterResourceProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DataCenterResourceProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the DataCenterResourceProperties.

managedDiskCustomerKeyUri

public String managedDiskCustomerKeyUri()

Get the managedDiskCustomerKeyUri property: 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.

Returns:

the managedDiskCustomerKeyUri value.

nodeCount

public Integer nodeCount()

Get the nodeCount property: 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.

Returns:

the nodeCount value.

privateEndpointIpAddress

public String privateEndpointIpAddress()

Get the privateEndpointIpAddress property: Ip of the VPN Endpoint for this data center.

Returns:

the privateEndpointIpAddress value.

provisionError

public CassandraError provisionError()

Get the provisionError property: Error related to resource provisioning.

Returns:

the provisionError value.

provisioningState

public ManagedCassandraProvisioningState provisioningState()

Get the provisioningState property: The status of the resource at the time the operation was called.

Returns:

the provisioningState value.

seedNodes

public List seedNodes()

Get the seedNodes property: 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.

Returns:

the seedNodes value.

sku

public String sku()

Get the sku property: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.

Returns:

the sku value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withAuthenticationMethodLdapProperties

public DataCenterResourceProperties withAuthenticationMethodLdapProperties(AuthenticationMethodLdapProperties authenticationMethodLdapProperties)

Set the authenticationMethodLdapProperties property: Ldap authentication method properties. This feature is in preview.

Parameters:

authenticationMethodLdapProperties - the authenticationMethodLdapProperties value to set.

Returns:

the DataCenterResourceProperties object itself.

withAvailabilityZone

public DataCenterResourceProperties withAvailabilityZone(Boolean availabilityZone)

Set the availabilityZone property: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.

Parameters:

availabilityZone - the availabilityZone value to set.

Returns:

the DataCenterResourceProperties object itself.

withBackupStorageCustomerKeyUri

public DataCenterResourceProperties withBackupStorageCustomerKeyUri(String backupStorageCustomerKeyUri)

Set the backupStorageCustomerKeyUri property: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.

Parameters:

backupStorageCustomerKeyUri - the backupStorageCustomerKeyUri value to set.

Returns:

the DataCenterResourceProperties object itself.

withBase64EncodedCassandraYamlFragment

public DataCenterResourceProperties withBase64EncodedCassandraYamlFragment(String base64EncodedCassandraYamlFragment)

Set the base64EncodedCassandraYamlFragment property: 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.

Parameters:

base64EncodedCassandraYamlFragment - the base64EncodedCassandraYamlFragment value to set.

Returns:

the DataCenterResourceProperties object itself.

withDataCenterLocation

public DataCenterResourceProperties withDataCenterLocation(String dataCenterLocation)

Set the dataCenterLocation property: The region this data center should be created in.

Parameters:

dataCenterLocation - the dataCenterLocation value to set.

Returns:

the DataCenterResourceProperties object itself.

withDeallocated

public DataCenterResourceProperties withDeallocated(Boolean deallocated)

Set the deallocated property: Whether the data center has been deallocated.

Parameters:

deallocated - the deallocated value to set.

Returns:

the DataCenterResourceProperties object itself.

withDelegatedSubnetId

public DataCenterResourceProperties withDelegatedSubnetId(String delegatedSubnetId)

Set the delegatedSubnetId property: 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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.

Parameters:

delegatedSubnetId - the delegatedSubnetId value to set.

Returns:

the DataCenterResourceProperties object itself.

withDiskCapacity

public DataCenterResourceProperties withDiskCapacity(Integer diskCapacity)

Set the diskCapacity property: Number of disks attached to each node. Default is 4.

Parameters:

diskCapacity - the diskCapacity value to set.

Returns:

the DataCenterResourceProperties object itself.

withDiskSku

public DataCenterResourceProperties withDiskSku(String diskSku)

Set the diskSku property: Disk SKU used for data centers. Default value is P30.

Parameters:

diskSku - the diskSku value to set.

Returns:

the DataCenterResourceProperties object itself.

withManagedDiskCustomerKeyUri

public DataCenterResourceProperties withManagedDiskCustomerKeyUri(String managedDiskCustomerKeyUri)

Set the managedDiskCustomerKeyUri property: 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.

Parameters:

managedDiskCustomerKeyUri - the managedDiskCustomerKeyUri value to set.

Returns:

the DataCenterResourceProperties object itself.

withNodeCount

public DataCenterResourceProperties withNodeCount(Integer nodeCount)

Set the nodeCount property: 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.

Parameters:

nodeCount - the nodeCount value to set.

Returns:

the DataCenterResourceProperties object itself.

withPrivateEndpointIpAddress

public DataCenterResourceProperties withPrivateEndpointIpAddress(String privateEndpointIpAddress)

Set the privateEndpointIpAddress property: Ip of the VPN Endpoint for this data center.

Parameters:

privateEndpointIpAddress - the privateEndpointIpAddress value to set.

Returns:

the DataCenterResourceProperties object itself.

withProvisionError

public DataCenterResourceProperties withProvisionError(CassandraError provisionError)

Set the provisionError property: Error related to resource provisioning.

Parameters:

provisionError - the provisionError value to set.

Returns:

the DataCenterResourceProperties object itself.

withProvisioningState

public DataCenterResourceProperties withProvisioningState(ManagedCassandraProvisioningState provisioningState)

Set the provisioningState property: The status of the resource at the time the operation was called.

Parameters:

provisioningState - the provisioningState value to set.

Returns:

the DataCenterResourceProperties object itself.

withSku

public DataCenterResourceProperties withSku(String sku)

Set the sku property: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.

Parameters:

sku - the sku value to set.

Returns:

the DataCenterResourceProperties object itself.

Applies to