cassandra_data_center

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

Overview

Name	cassandra_data_center
Type	Resource
Id	azure.cosmos_db.cassandra_data_center

Fields

The following fields are returned by SELECT queries:

get

The properties of the managed Cassandra data center were retrieved successfully.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Properties of a managed Cassandra data center.
type	string	The type of Azure resource.

list

Successfully retrieved the list of managed Cassandra data centers.

Name	Datatype	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	object	Properties of a managed Cassandra data center.
type	string	The type of Azure resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, dataCenterName		Get the properties of a managed Cassandra data center.
list	select	subscriptionId, resourceGroupName, clusterName		List all data centers in a particular managed Cassandra cluster.
create_update	insert	subscriptionId, resourceGroupName, clusterName, dataCenterName		Create or update a managed Cassandra data center. When updating, overwrite all properties. To update only some properties, use PATCH.
update	update	subscriptionId, resourceGroupName, clusterName, dataCenterName		Update some of the properties of a managed Cassandra data center.
delete	delete	subscriptionId, resourceGroupName, clusterName, dataCenterName		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
clusterName	string	Managed Cassandra cluster name.
dataCenterName	string	Data center name in a managed Cassandra cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Get the properties of a managed Cassandra data center.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.cassandra_data_center
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND dataCenterName = '{{ dataCenterName }}' -- required
;

list

List all data centers in a particular managed Cassandra cluster.

SELECT
id,
name,
properties,
type
FROM azure.cosmos_db.cassandra_data_center
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- 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.cosmos_db.cassandra_data_center (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
dataCenterName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ dataCenterName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: cassandra_data_center
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the cassandra_data_center resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cassandra_data_center resource.
    - name: clusterName
      value: string
      description: Required parameter for the cassandra_data_center resource.
    - name: dataCenterName
      value: string
      description: Required parameter for the cassandra_data_center resource.
    - name: properties
      value: object
      description: |
        Properties of a managed Cassandra data center.

UPDATE examples

update

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

UPDATE azure.cosmos_db.cassandra_data_center
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND dataCenterName = '{{ dataCenterName }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Delete a managed Cassandra data center.

DELETE FROM azure.cosmos_db.cassandra_data_center
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND dataCenterName = '{{ dataCenterName }}' --required
;