Cassandra Resources - Get Cassandra Table

Referensi

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Mendapatkan tabel Cassandra di bawah akun database Azure Cosmos DB yang ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun database Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
keyspaceName	path	True	string	Nama keyspace Cosmos DB.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
tableName	path	True	string	Nama tabel Cosmos DB.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	CassandraTableGetResults	Properti tabel Cassandra berhasil diambil.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

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\""
    }
  }
}

Definisi

Nama	Deskripsi
AutoscaleSettings
CassandraPartitionKey	Kunci partisi tabel Cosmos DB Cassandra
CassandraSchema	Skema tabel Cosmos DB Cassandra
CassandraTableGetResults	Tabel Azure Cosmos DB Cassandra.
ClusterKey	Kunci kluster tabel Cosmos DB Cassandra
Column	Kolom tabel Cosmos DB Cassandra
Options
Resource

AutoscaleSettings

Nama	Jenis	Deskripsi
maxThroughput	integer	Mewakili throughput maksimum, sumber daya dapat ditingkatkan skalanya.

CassandraPartitionKey

Kunci partisi tabel Cosmos DB Cassandra

Nama	Jenis	Deskripsi
name	string	Nama kunci partisi tabel Cosmos DB Cassandra

CassandraSchema

Skema tabel Cosmos DB Cassandra

Nama	Jenis	Deskripsi
clusterKeys	ClusterKey[]	Daftar kunci kluster.
columns	Column[]	Daftar kolom tabel Cassandra.
partitionKeys	CassandraPartitionKey[]	Daftar kunci partisi.

CassandraTableGetResults

Tabel Azure Cosmos DB Cassandra.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya unik sumber daya ARM.
location	string	Lokasi grup sumber daya tempat sumber daya berada.
name	string	Nama sumber daya ARM.
properties.options	Options
properties.resource	Resource
tags	object	Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam menampilkan dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".
type	string	Jenis sumber daya Azure.

ClusterKey

Kunci kluster tabel Cosmos DB Cassandra

Nama	Jenis	Deskripsi
name	string	Nama kunci kluster tabel Cosmos DB Cassandra
orderBy	string	Urutan kunci kluster tabel Cosmos DB Cassandra, hanya mendukung "Asc" dan "Desc"

Column

Kolom tabel Cosmos DB Cassandra

Nama	Jenis	Deskripsi
name	string	Nama kolom tabel Cosmos DB Cassandra
type	string	Jenis kolom tabel Cosmos DB Cassandra

Options

Nama	Jenis	Deskripsi
autoscaleSettings	AutoscaleSettings	Menentukan pengaturan Skala Otomatis.
throughput	integer	Nilai throughput sumber daya Cosmos DB atau autoscaleSettings. Gunakan sumber daya ThroughputSetting saat mengambil detail penawaran.

Resource

Nama	Jenis	Deskripsi
_etag	string	Properti yang dihasilkan sistem yang mewakili etag sumber daya yang diperlukan untuk kontrol konkurensi optimis.
_rid	string	Properti yang dihasilkan sistem. Pengidentifikasi unik.
_ts	number	Properti yang dihasilkan sistem yang menunjukkan tanda waktu terakhir yang diperbarui dari sumber daya.
analyticalStorageTtl	integer	TTL Analitis.
defaultTtl	integer	Waktu hidup tabel Cosmos DB Cassandra
id	string	Nama tabel Cosmos DB Cassandra
schema	CassandraSchema	Skema tabel Cosmos DB Cassandra

Cassandra Resources - Get Cassandra Table

Parameter URI

Respons

Keamanan

azure_auth

Scopes

Contoh

CosmosDBCassandraTableGet

Sample Request

Sample Response

Definisi

AutoscaleSettings

CassandraPartitionKey

CassandraSchema

CassandraTableGetResults

ClusterKey

Column

Options

Resource

Sumber Daya Tambahan: