Cassandra Resources - Get Cassandra Table

Service:: Cosmos DB Resource Provider

API Version:: 2024-11-15

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}?api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB database account name.
keyspaceName	path	True	string	Cosmos DB keyspace name.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
tableName	path	True	string	Cosmos DB table name.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	CassandraTableGetResults	The Cassandra table property was retrieved successfully.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Impersonate your user account

Examples

CosmosDBCassandraTableGet

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/tables/tableName?api-version=2024-11-15


/**
 * Samples for CassandraResources GetCassandraTable.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
     * CosmosDBCassandraTableGet.json
     */
    /**
     * Sample code: CosmosDBCassandraTableGet.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBCassandraTableGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getCassandraResources().getCassandraTableWithResponse("rg1",
            "ddb1", "keyspaceName", "tableName", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_cassandra_table_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.cassandra_resources.get_cassandra_table(
        resource_group_name="rg1",
        account_name="ddb1",
        keyspace_name="keyspaceName",
        table_name="tableName",
    )
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBCassandraTableGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBCassandraTableGet.json
func ExampleCassandraResourcesClient_GetCassandraTable() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCassandraResourcesClient().GetCassandraTable(ctx, "rg1", "ddb1", "keyspaceName", "tableName", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CassandraTableGetResults = armcosmos.CassandraTableGetResults{
	// 	Name: to.Ptr("tableName"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcosmos.CassandraTableGetProperties{
	// 		Resource: &armcosmos.CassandraTableGetPropertiesResource{
	// 			Schema: &armcosmos.CassandraSchema{
	// 				ClusterKeys: []*armcosmos.ClusterKey{
	// 					{
	// 						Name: to.Ptr("columnA"),
	// 						OrderBy: to.Ptr("Asc"),
	// 				}},
	// 				Columns: []*armcosmos.Column{
	// 					{
	// 						Name: to.Ptr("columnA"),
	// 						Type: to.Ptr("Ascii"),
	// 				}},
	// 				PartitionKeys: []*armcosmos.CassandraPartitionKey{
	// 					{
	// 						Name: to.Ptr("columnA"),
	// 				}},
	// 			},
	// 			DefaultTTL: to.Ptr[int32](100),
	// 			ID: to.Ptr("tableName"),
	// 			Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
	// 			Rid: to.Ptr("PD5DALigDgw="),
	// 			Ts: to.Ptr[float32](1459200611),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the Cassandra table under an existing Azure Cosmos DB database account.
 *
 * @summary Gets the Cassandra table under an existing Azure Cosmos DB database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBCassandraTableGet.json
 */
async function cosmosDbCassandraTableGet() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const keyspaceName = "keyspaceName";
  const tableName = "tableName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.cassandraResources.getCassandraTable(
    resourceGroupName,
    accountName,
    keyspaceName,
    tableName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName",
  "name": "tableName",
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "tableName",
      "defaultTtl": 100,
      "schema": {
        "columns": [
          {
            "name": "columnA",
            "type": "Ascii"
          }
        ],
        "partitionKeys": [
          {
            "name": "columnA"
          }
        ],
        "clusterKeys": [
          {
            "name": "columnA",
            "orderBy": "Asc"
          }
        ]
      },
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Definitions

Name	Description
AutoscaleSettings
CassandraPartitionKey	Cosmos DB Cassandra table partition key
CassandraSchema	Cosmos DB Cassandra table schema
CassandraTableGetResults	An Azure Cosmos DB Cassandra table.
ClusterKey	Cosmos DB Cassandra table cluster key
Column	Cosmos DB Cassandra table column
Options
Resource

AutoscaleSettings

Object

Name	Type	Description
maxThroughput	integer	Represents maximum throughput, the resource can scale up to.

CassandraPartitionKey

Object

Cosmos DB Cassandra table partition key

Name	Type	Description
name	string	Name of the Cosmos DB Cassandra table partition key

CassandraSchema

Object

Cosmos DB Cassandra table schema

Name	Type	Description
clusterKeys	ClusterKey[]	List of cluster key.
columns	Column[]	List of Cassandra table columns.
partitionKeys	CassandraPartitionKey[]	List of partition key.

CassandraTableGetResults

Object

An Azure Cosmos DB Cassandra table.

Name	Type	Description
id	string	The unique resource identifier of the ARM resource.
location	string	The location of the resource group to which the resource belongs.
name	string	The name of the ARM resource.
properties.options	Options
properties.resource	Resource
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 Azure resource.

ClusterKey

Object

Cosmos DB Cassandra table cluster key

Name	Type	Description
name	string	Name of the Cosmos DB Cassandra table cluster key
orderBy	string	Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc"

Column

Object

Cosmos DB Cassandra table column

Name	Type	Description
name	string	Name of the Cosmos DB Cassandra table column
type	string	Type of the Cosmos DB Cassandra table column

Options

Object

Name	Type	Description
autoscaleSettings	AutoscaleSettings	Specifies the Autoscale settings.
throughput	integer	Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

Resource

Object

Name	Type	Description
_etag	string	A system generated property representing the resource etag required for optimistic concurrency control.
_rid	string	A system generated property. A unique identifier.
_ts	number	A system generated property that denotes the last updated timestamp of the resource.
analyticalStorageTtl	integer	Analytical TTL.
defaultTtl	integer	Time to live of the Cosmos DB Cassandra table
id	string	Name of the Cosmos DB Cassandra table
schema	CassandraSchema	Schema of the Cosmos DB Cassandra table

Share via

Cassandra Resources - Get Cassandra Table

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

CosmosDBCassandraTableGet

Sample request

Sample response

Definitions

AutoscaleSettings

CassandraPartitionKey

CassandraSchema

CassandraTableGetResults

ClusterKey

Column

Options

Resource