Share via

DataCenterResourceProperties interface

  • Reference
Package:
@azure/arm-cosmosdb

Properties of a managed Cassandra data center.

Properties

authenticationMethodLdapProperties

Ldap authentication method properties. This feature is in preview.
availabilityZone

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

Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
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.
dataCenterLocation

The region this data center should be created in.
deallocated

Whether the data center has been deallocated.
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//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
diskCapacity

Number of disks attached to each node. Default is 4.
diskSku

Disk SKU used for data centers. Default value is P30.
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.
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.
privateEndpointIpAddress

Ip of the VPN Endpoint for this data center.
provisionError

Error related to resource provisioning.
provisioningState

The status of the resource at the time the operation was called.
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. NOTE: This property will not be serialized. It can only be populated by the server.
sku

Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2

Property Details

authenticationMethodLdapProperties

Ldap authentication method properties. This feature is in preview.

authenticationMethodLdapProperties?: AuthenticationMethodLdapProperties

Property Value

AuthenticationMethodLdapProperties

availabilityZone

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

availabilityZone?: boolean

Property Value

boolean

backupStorageCustomerKeyUri

Indicates the Key Uri of the customer key to use for encryption of the backup storage account.

backupStorageCustomerKeyUri?: string

Property Value

string

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.

base64EncodedCassandraYamlFragment?: string

Property Value

string

dataCenterLocation

The region this data center should be created in.

dataCenterLocation?: string

Property Value

string

deallocated

Whether the data center has been deallocated.

deallocated?: boolean

Property Value

boolean

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

delegatedSubnetId?: string

Property Value

string

diskCapacity

Number of disks attached to each node. Default is 4.

diskCapacity?: number

Property Value

number

diskSku

Disk SKU used for data centers. Default value is P30.

diskSku?: string

Property Value

string

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.

managedDiskCustomerKeyUri?: string

Property Value

string

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.

nodeCount?: number

Property Value

number

privateEndpointIpAddress

Ip of the VPN Endpoint for this data center.

privateEndpointIpAddress?: string

Property Value

string

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

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

seedNodes?: SeedNode[]

Property Value

SeedNode[]

sku

Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2

sku?: string

Property Value

string