Cassandra Resources - List Cassandra Tables

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Listas a tabela cassandra numa conta de base de dados do Azure Cosmos DB existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	Nome da conta da base de dados do Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
keyspaceName	path	True	string	Nome do espaço de chaves do Cosmos DB.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	CassandraTableListResult	As propriedades da tabela cassandra foram obtidas com êxito.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Exemplos

CosmosDBCassandraTableList

Sample Request

HTTP

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

Java

/**
 * Samples for CassandraResources ListCassandraTables.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBCassandraTableList.json
     */
    /**
     * Sample code: CosmosDBCassandraTableList.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBCassandraTableList(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getCassandraResources().listCassandraTables("rgName", "ddb1",
            "keyspaceName", 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

Python

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_list.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.list_cassandra_tables(
        resource_group_name="rgName",
        account_name="ddb1",
        keyspace_name="keyspaceName",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableList.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

Go

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableList.json
func ExampleCassandraResourcesClient_NewListCassandraTablesPager() {
	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)
	}
	pager := clientFactory.NewCassandraResourcesClient().NewListCassandraTablesPager("rgName", "ddb1", "keyspaceName", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CassandraTableListResult = armcosmos.CassandraTableListResult{
		// 	Value: []*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"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists the Cassandra table under an existing Azure Cosmos DB database account.
 *
 * @summary Lists the Cassandra table under an existing Azure Cosmos DB database account.
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBCassandraTableList.json
 */
async function cosmosDbCassandraTableList() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rgName";
  const accountName = "ddb1";
  const keyspaceName = "keyspaceName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.cassandraResources.listCassandraTables(
    resourceGroupName,
    accountName,
    keyspaceName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

{
  "value": [
    {
      "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"
              }
            ]
          }
        }
      }
    }
  ]
}

Definições

Name	Description
AutoscaleSettings
CassandraPartitionKey	Chave de partição da tabela cassandra do Cosmos DB
CassandraSchema	Esquema de tabela para Cassandra do Cosmos DB
CassandraTableGetResults	Uma tabela cassandra do Azure Cosmos DB.
CassandraTableListResult	A resposta da operação Lista, que contém as tabelas do Cassandra e as respetivas propriedades.
ClusterKey	Chave do cluster de tabelas para Cassandra do Cosmos DB
Column	Coluna da tabela Cassandra do Cosmos DB
Options
Resource

AutoscaleSettings

Name	Tipo	Description
maxThroughput	integer	Representa o débito máximo, o recurso pode aumentar verticalmente.

CassandraPartitionKey

Chave de partição da tabela cassandra do Cosmos DB

Name	Tipo	Description
name	string	Nome da chave de partição da tabela cassandra do Cosmos DB

CassandraSchema

Esquema de tabela para Cassandra do Cosmos DB

Name	Tipo	Description
clusterKeys	ClusterKey[]	Lista de chaves de cluster.
columns	Column[]	Lista de colunas de tabelas do Cassandra.
partitionKeys	CassandraPartitionKey[]	Lista de chaves de partição.

CassandraTableGetResults

Uma tabela cassandra do Azure Cosmos DB.

Name	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso arm.
location	string	A localização do grupo de recursos ao qual o recurso pertence.
name	string	O nome do recurso arm.
properties.options	Options
properties.resource	Resource
tags	object	As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB".
type	string	O tipo de recurso do Azure.

CassandraTableListResult

A resposta da operação Lista, que contém as tabelas do Cassandra e as respetivas propriedades.

Name	Tipo	Description
value	CassandraTableGetResults[]	Lista de tabelas do Cassandra e respetivas propriedades.

ClusterKey

Chave do cluster de tabelas para Cassandra do Cosmos DB

Name	Tipo	Description
name	string	Nome da chave de cluster de tabela do Cassandra do Cosmos DB
orderBy	string	A ordem da chave de cluster da tabela Cassandra do Cosmos DB só suporta "Asc" e "Desc"

Column

Coluna da tabela Cassandra do Cosmos DB

Name	Tipo	Description
name	string	Nome da coluna da tabela Cassandra do Cosmos DB
type	string	Tipo da coluna da tabela Cassandra do Cosmos DB

Options

Name	Tipo	Description
autoscaleSettings	AutoscaleSettings	Especifica as definições de Dimensionamento Automático.
throughput	integer	Valor do débito de recursos do Cosmos DB ou dimensionamento automáticoDefinições. Utilize o recurso ThroughputSetting ao obter os detalhes da oferta.

Resource

Name	Tipo	Description
_etag	string	Uma propriedade gerada pelo sistema que representa o etag de recursos necessário para o controlo de simultaneidade otimista.
_rid	string	Uma propriedade gerada pelo sistema. Um identificador exclusivo.
_ts	number	Uma propriedade gerada pelo sistema que indica o último carimbo de data/hora atualizado do recurso.
analyticalStorageTtl	integer	TTL Analítico.
defaultTtl	integer	Tempo de vida da tabela Cassandra do Cosmos DB
id	string	Nome da tabela Cassandra do Cosmos DB
schema	CassandraSchema	Esquema da tabela cassandra do Cosmos DB