你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Cassandra Resources - Get Cassandra Table

参考

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

获取现有 Azure Cosmos DB 数据库帐户下的 Cassandra 表。

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	Cosmos DB 数据库帐户名称。 Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
keyspaceName	path	True	string	Cosmos DB 密钥空间名称。
resourceGroupName	path	True	string	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string	目标订阅的 ID。
tableName	path	True	string	Cosmos DB 表名称。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	CassandraTableGetResults	已成功检索 Cassandra 表属性。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

CosmosDBCassandraTableGet

Sample Request

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


/**
 * Samples for CassandraResources GetCassandraTable.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-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/2023-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/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/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/2023-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\""
    }
  }
}

定义

名称	说明
AutoscaleSettings
CassandraPartitionKey	Cosmos DB Cassandra 表分区键
CassandraSchema	Cosmos DB Cassandra 表架构
CassandraTableGetResults	Azure Cosmos DB Cassandra 表。
ClusterKey	Cosmos DB Cassandra 表群集密钥
Column	Cosmos DB Cassandra 表列
Options
Resource

AutoscaleSettings

名称	类型	说明
maxThroughput	integer	表示资源可纵向扩展的最大吞吐量。

CassandraPartitionKey

Cosmos DB Cassandra 表分区键

名称	类型	说明
name	string	Cosmos DB Cassandra 表分区键的名称

CassandraSchema

Cosmos DB Cassandra 表架构

名称	类型	说明
clusterKeys	ClusterKey[]	群集密钥列表。
columns	Column[]	Cassandra 表列的列表。
partitionKeys	CassandraPartitionKey[]	分区键列表。

CassandraTableGetResults

Azure Cosmos DB Cassandra 表。

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
location	string	资源所属的资源组的位置。
name	string	ARM 资源的名称。
properties.options	Options
properties.resource	Resource
tags	object	标记是描述资源的键值对的列表。在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。最多可以为一个资源提供 15 个标记。每个标记的键不能超过 128 个字符，值不能超过 256 个字符。例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
type	string	Azure 资源的类型。

ClusterKey

Cosmos DB Cassandra 表群集密钥

名称	类型	说明
name	string	Cosmos DB Cassandra 表群集密钥的名称
orderBy	string	Cosmos DB Cassandra 表群集密钥的顺序，仅支持“Asc”和“Desc”

Column

Cosmos DB Cassandra 表列

名称	类型	说明
name	string	Cosmos DB Cassandra 表列的名称
type	string	Cosmos DB Cassandra 表列的类型

Options

名称	类型	说明
autoscaleSettings	AutoscaleSettings	指定自动缩放设置。
throughput	integer	Cosmos DB 资源吞吐量或自动缩放设置的值。检索产品/服务详细信息时，请使用 ThroughputSetting 资源。

Resource

名称	类型	说明
_etag	string	表示乐观并发控制所需的资源 etag 的系统生成的属性。
_rid	string	系统生成的属性。唯一标识符。
_ts	number	一个系统生成的属性，表示资源的上次更新时间戳。
analyticalStorageTtl	integer	分析 TTL。
defaultTtl	integer	Cosmos DB Cassandra 表的生存时间
id	string	Cosmos DB Cassandra 表的名称
schema	CassandraSchema	Cosmos DB Cassandra 表的架构

Cassandra Resources - Get Cassandra Table

URI 参数

响应

安全性

azure_auth

Scopes

示例

CosmosDBCassandraTableGet

Sample Request

Sample Response

定义

AutoscaleSettings

CassandraPartitionKey

CassandraSchema

CassandraTableGetResults

ClusterKey

Column

Options

Resource

其他资源