cassandra_data_centers

Creates, updates, deletes, gets or lists a cassandra_data_centers resource.

Overview

Name	cassandra_data_centers
Type	Resource
Id	azure.cosmosdb.cassandra_data_centers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authenticationMethodLdapProperties	object	Ldap authentication method properties. This feature is in preview.
availabilityZone	boolean	If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
backupStorageCustomerKeyUri	string	Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
base64EncodedCassandraYamlFragment	string	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	string	The region this data center should be created in.
deallocated	boolean	Whether the data center has been deallocated.
delegatedSubnetId	string	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	integer	Number of disks attached to each node. Default is 4.
diskSku	string	Disk SKU used for data centers. Default value is P30.
managedDiskCustomerKeyUri	string	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	integer	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	string	Ip of the VPN Endpoint for this data center.
provisionError	object	CassandraError.
provisioningState	string	The status of the resource at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
seedNodes	array	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.
sku	string	Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
authenticationMethodLdapProperties	object	Ldap authentication method properties. This feature is in preview.
availabilityZone	boolean	If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
backupStorageCustomerKeyUri	string	Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
base64EncodedCassandraYamlFragment	string	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	string	The region this data center should be created in.
deallocated	boolean	Whether the data center has been deallocated.
delegatedSubnetId	string	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	integer	Number of disks attached to each node. Default is 4.
diskSku	string	Disk SKU used for data centers. Default value is P30.
managedDiskCustomerKeyUri	string	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	integer	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	string	Ip of the VPN Endpoint for this data center.
provisionError	object	CassandraError.
provisioningState	string	The status of the resource at the time the operation was called. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
seedNodes	array	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.
sku	string	Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_name, data_center_name, subscription_id		Get the properties of a managed Cassandra data center.
list	select	resource_group_name, cluster_name, subscription_id		List all data centers in a particular managed Cassandra cluster.
create_update	insert	resource_group_name, cluster_name, data_center_name, subscription_id		Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.
update	update	resource_group_name, cluster_name, data_center_name, subscription_id		Update some of the properties of a managed Cassandra data center.
create_update	replace	resource_group_name, cluster_name, data_center_name, subscription_id		Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.
delete	delete	resource_group_name, cluster_name, data_center_name, subscription_id		Delete a managed Cassandra data center.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cluster_name	string	Managed Cassandra cluster name. Required.
data_center_name	string	Data center name in a managed Cassandra cluster. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the properties of a managed Cassandra data center.

SELECT
id,
name,
authenticationMethodLdapProperties,
availabilityZone,
backupStorageCustomerKeyUri,
base64EncodedCassandraYamlFragment,
dataCenterLocation,
deallocated,
delegatedSubnetId,
diskCapacity,
diskSku,
managedDiskCustomerKeyUri,
nodeCount,
privateEndpointIpAddress,
provisionError,
provisioningState,
seedNodes,
sku,
systemData,
type
FROM azure.cosmosdb.cassandra_data_centers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND data_center_name = '{{ data_center_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all data centers in a particular managed Cassandra cluster.

SELECT
id,
name,
authenticationMethodLdapProperties,
availabilityZone,
backupStorageCustomerKeyUri,
base64EncodedCassandraYamlFragment,
dataCenterLocation,
deallocated,
delegatedSubnetId,
diskCapacity,
diskSku,
managedDiskCustomerKeyUri,
nodeCount,
privateEndpointIpAddress,
provisionError,
provisioningState,
seedNodes,
sku,
systemData,
type
FROM azure.cosmosdb.cassandra_data_centers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_update

Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.

INSERT INTO azure.cosmosdb.cassandra_data_centers (
properties,
resource_group_name,
cluster_name,
data_center_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ data_center_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: cassandra_data_centers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cassandra_data_centers resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the cassandra_data_centers resource.
  - name: data_center_name
    value: "{{ data_center_name }}"
    description: Required parameter for the cassandra_data_centers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cassandra_data_centers resource.
  - name: properties
    description: |
      Properties of a managed Cassandra data center.
    value:
      provisioningState: "{{ provisioningState }}"
      dataCenterLocation: "{{ dataCenterLocation }}"
      delegatedSubnetId: "{{ delegatedSubnetId }}"
      nodeCount: {{ nodeCount }}
      seedNodes:
        - ipAddress: "{{ ipAddress }}"
      base64EncodedCassandraYamlFragment: "{{ base64EncodedCassandraYamlFragment }}"
      managedDiskCustomerKeyUri: "{{ managedDiskCustomerKeyUri }}"
      backupStorageCustomerKeyUri: "{{ backupStorageCustomerKeyUri }}"
      sku: "{{ sku }}"
      diskSku: "{{ diskSku }}"
      diskCapacity: {{ diskCapacity }}
      availabilityZone: {{ availabilityZone }}
      authenticationMethodLdapProperties:
        serverHostname: "{{ serverHostname }}"
        serverPort: {{ serverPort }}
        serviceUserDistinguishedName: "{{ serviceUserDistinguishedName }}"
        serviceUserPassword: "{{ serviceUserPassword }}"
        searchBaseDistinguishedName: "{{ searchBaseDistinguishedName }}"
        searchFilterTemplate: "{{ searchFilterTemplate }}"
        serverCertificates:
          - pem: "{{ pem }}"
        connectionTimeoutInMs: {{ connectionTimeoutInMs }}
      deallocated: {{ deallocated }}
      provisionError:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        additionalErrorInfo: "{{ additionalErrorInfo }}"
      privateEndpointIpAddress: "{{ privateEndpointIpAddress }}"

UPDATE examples

update

Update some of the properties of a managed Cassandra data center.

UPDATE azure.cosmosdb.cassandra_data_centers
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND data_center_name = '{{ data_center_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_update

Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.

REPLACE azure.cosmosdb.cassandra_data_centers
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND data_center_name = '{{ data_center_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a managed Cassandra data center.

DELETE FROM azure.cosmosdb.cassandra_data_centers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND data_center_name = '{{ data_center_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;