cassandra_resources

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

Overview

Name	cassandra_resources
Type	Resource
Id	azure.cosmosdb.cassandra_resources

Fields

The following fields are returned by SELECT queries:

get_cassandra_table_throughput

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.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.ThroughputSettingsGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_cassandra_tables

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.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
options	object	:vartype options: ~azure.mgmt.cosmosdb.models.CassandraTableGetPropertiesOptions
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.CassandraTableGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_cassandra_role_definition

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.
assignableScopes	array	A set of fully qualified Scopes at or below which Cassandra Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
permissions	array	The set of operations allowed through this Role Definition.
roleName	string	A user-friendly name for the Role Definition. Must be unique for the database account.
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".

get_cassandra_role_assignment

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.
principalId	string	The unique identifier for the associated AAD principal in the AAD graph to which access is being granted through this Cassandra Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription.
provisioningState	string	Provisioning state of the resource.
roleDefinitionId	string	The unique identifier for the associated Role Definition.
scope	string	The data plane resource path for which access is being granted through this Cassandra Role Assignment.
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_cassandra_keyspaces

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.
identity	object	Identity for the resource.
location	string	The location of the resource group to which the resource belongs.
options	object	:vartype options: ~azure.mgmt.cosmosdb.models.CassandraKeyspaceGetPropertiesOptions
resource	object	:vartype resource: ~azure.mgmt.cosmosdb.models.CassandraKeyspaceGetPropertiesResource
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
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_cassandra_table_throughput	select	resource_group_name, account_name, keyspace_name, table_name, subscription_id		Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.
list_cassandra_tables	select	resource_group_name, account_name, keyspace_name, subscription_id		Lists the Cassandra table under an existing Azure Cosmos DB database account.
get_cassandra_role_definition	select	resource_group_name, account_name, role_definition_id, subscription_id		Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Definition with the given Id.
get_cassandra_role_assignment	select	resource_group_name, account_name, role_assignment_id, subscription_id		Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Assignment with the given Id.
list_cassandra_keyspaces	select	resource_group_name, account_name, subscription_id		Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.
list_cassandra_role_definitions	exec	resource_group_name, account_name, subscription_id		Retrieves the list of all Azure Cosmos DB Cassandra Role Definitions.
list_cassandra_role_assignments	exec	resource_group_name, account_name, subscription_id		Retrieves the list of all Azure Cosmos DB Cassandra Role Assignments.
get_cassandra_keyspace_throughput	exec	resource_group_name, account_name, keyspace_name, subscription_id		Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.
update_cassandra_keyspace_throughput	exec	resource_group_name, account_name, keyspace_name, subscription_id, properties		Update RUs per second of an Azure Cosmos DB Cassandra Keyspace.
update_cassandra_table_throughput	exec	resource_group_name, account_name, keyspace_name, table_name, subscription_id, properties		Update RUs per second of an Azure Cosmos DB Cassandra table.
get_cassandra_keyspace	exec	resource_group_name, account_name, keyspace_name, subscription_id		Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.
create_update_cassandra_keyspace	exec	resource_group_name, account_name, keyspace_name, subscription_id, properties		Create or update an Azure Cosmos DB Cassandra keyspace.
delete_cassandra_keyspace	exec	resource_group_name, account_name, keyspace_name, subscription_id		Deletes an existing Azure Cosmos DB Cassandra keyspace.
get_cassandra_table	exec	resource_group_name, account_name, keyspace_name, table_name, subscription_id		Gets the Cassandra table under an existing Azure Cosmos DB database account.
create_update_cassandra_table	exec	resource_group_name, account_name, keyspace_name, table_name, subscription_id, properties		Create or update an Azure Cosmos DB Cassandra Table.
delete_cassandra_table	exec	resource_group_name, account_name, keyspace_name, table_name, subscription_id		Deletes an existing Azure Cosmos DB Cassandra table.
create_update_cassandra_role_definition	exec	resource_group_name, account_name, role_definition_id, subscription_id		Creates or updates an Azure Cosmos DB Cassandra Role Definition.
delete_cassandra_role_definition	exec	resource_group_name, account_name, role_definition_id, subscription_id		Deletes an existing Azure Cosmos DB Cassandra Role Definition.
create_update_cassandra_role_assignment	exec	resource_group_name, account_name, role_assignment_id, subscription_id		Creates or updates an Azure Cosmos DB Cassandra Role Assignment.
delete_cassandra_role_assignment	exec	resource_group_name, account_name, role_assignment_id, subscription_id		Deletes an existing Azure Cosmos DB Cassandra Role Assignment.
migrate_cassandra_keyspace_to_autoscale	exec	resource_group_name, account_name, keyspace_name, subscription_id		Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale.
migrate_cassandra_keyspace_to_manual_throughput	exec	resource_group_name, account_name, keyspace_name, subscription_id		Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput.
migrate_cassandra_table_to_autoscale	exec	resource_group_name, account_name, keyspace_name, table_name, subscription_id		Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale.
migrate_cassandra_table_to_manual_throughput	exec	resource_group_name, account_name, keyspace_name, table_name, subscription_id		Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput.

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
account_name	string	Cosmos DB database account name. Required.
keyspace_name	string	Cosmos DB keyspace name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
role_assignment_id	string	The GUID for the Role Assignment. Required.
role_definition_id	string	The GUID for the Role Definition. Required.
subscription_id	string
table_name	string	Cosmos DB table name. Required.

SELECT examples

get_cassandra_table_throughput

Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.

SELECT
id,
name,
identity,
location,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.cassandra_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND keyspace_name = '{{ keyspace_name }}' -- required
AND table_name = '{{ table_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_cassandra_tables

Lists the Cassandra table under an existing Azure Cosmos DB database account.

SELECT
id,
name,
identity,
location,
options,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.cassandra_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND keyspace_name = '{{ keyspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_cassandra_role_definition

Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Definition with the given Id.

SELECT
id,
name,
assignableScopes,
permissions,
roleName,
systemData,
type
FROM azure.cosmosdb.cassandra_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND role_definition_id = '{{ role_definition_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_cassandra_role_assignment

Retrieves the properties of an existing Azure Cosmos DB Cassandra Role Assignment with the given Id.

SELECT
id,
name,
principalId,
provisioningState,
roleDefinitionId,
scope,
systemData,
type
FROM azure.cosmosdb.cassandra_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND role_assignment_id = '{{ role_assignment_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_cassandra_keyspaces

Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.

SELECT
id,
name,
identity,
location,
options,
resource,
systemData,
tags,
type
FROM azure.cosmosdb.cassandra_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

list_cassandra_role_definitions

Retrieves the list of all Azure Cosmos DB Cassandra Role Definitions.

EXEC azure.cosmosdb.cassandra_resources.list_cassandra_role_definitions 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_cassandra_role_assignments

Retrieves the list of all Azure Cosmos DB Cassandra Role Assignments.

EXEC azure.cosmosdb.cassandra_resources.list_cassandra_role_assignments 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_cassandra_keyspace_throughput

Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.

EXEC azure.cosmosdb.cassandra_resources.get_cassandra_keyspace_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

update_cassandra_keyspace_throughput

Update RUs per second of an Azure Cosmos DB Cassandra Keyspace.

EXEC azure.cosmosdb.cassandra_resources.update_cassandra_keyspace_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

update_cassandra_table_throughput

Update RUs per second of an Azure Cosmos DB Cassandra table.

EXEC azure.cosmosdb.cassandra_resources.update_cassandra_table_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

get_cassandra_keyspace

Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.

EXEC azure.cosmosdb.cassandra_resources.get_cassandra_keyspace 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_cassandra_keyspace

Create or update an Azure Cosmos DB Cassandra keyspace.

EXEC azure.cosmosdb.cassandra_resources.create_update_cassandra_keyspace 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_cassandra_keyspace

Deletes an existing Azure Cosmos DB Cassandra keyspace.

EXEC azure.cosmosdb.cassandra_resources.delete_cassandra_keyspace 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_cassandra_table

Gets the Cassandra table under an existing Azure Cosmos DB database account.

EXEC azure.cosmosdb.cassandra_resources.get_cassandra_table 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_cassandra_table

Create or update an Azure Cosmos DB Cassandra Table.

EXEC azure.cosmosdb.cassandra_resources.create_update_cassandra_table 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"identity": "{{ identity }}", 
"properties": "{{ properties }}"
}'
;

delete_cassandra_table

Deletes an existing Azure Cosmos DB Cassandra table.

EXEC azure.cosmosdb.cassandra_resources.delete_cassandra_table 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_cassandra_role_definition

Creates or updates an Azure Cosmos DB Cassandra Role Definition.

EXEC azure.cosmosdb.cassandra_resources.create_update_cassandra_role_definition 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_definition_id='{{ role_definition_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_cassandra_role_definition

Deletes an existing Azure Cosmos DB Cassandra Role Definition.

EXEC azure.cosmosdb.cassandra_resources.delete_cassandra_role_definition 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_definition_id='{{ role_definition_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_update_cassandra_role_assignment

Creates or updates an Azure Cosmos DB Cassandra Role Assignment.

EXEC azure.cosmosdb.cassandra_resources.create_update_cassandra_role_assignment 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_assignment_id='{{ role_assignment_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_cassandra_role_assignment

Deletes an existing Azure Cosmos DB Cassandra Role Assignment.

EXEC azure.cosmosdb.cassandra_resources.delete_cassandra_role_assignment 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@role_assignment_id='{{ role_assignment_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_cassandra_keyspace_to_autoscale

Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale.

EXEC azure.cosmosdb.cassandra_resources.migrate_cassandra_keyspace_to_autoscale 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_cassandra_keyspace_to_manual_throughput

Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput.

EXEC azure.cosmosdb.cassandra_resources.migrate_cassandra_keyspace_to_manual_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_cassandra_table_to_autoscale

Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale.

EXEC azure.cosmosdb.cassandra_resources.migrate_cassandra_table_to_autoscale 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

migrate_cassandra_table_to_manual_throughput

Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput.

EXEC azure.cosmosdb.cassandra_resources.migrate_cassandra_table_to_manual_throughput 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@keyspace_name='{{ keyspace_name }}' --required, 
@table_name='{{ table_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;