Cassandra Resources - Get Cassandra Table

Odwołanie

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

Pobiera tabelę Cassandra na istniejącym koncie bazy danych usługi Azure Cosmos DB.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string	Nazwa konta bazy danych usługi Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
keyspaceName	path	True	string	Nazwa przestrzeni kluczy usługi Cosmos DB.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
tableName	path	True	string	Nazwa tabeli usługi Cosmos DB.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CassandraTableGetResults	Właściwość tabeli Cassandra została pomyślnie pobrana.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

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

Definicje

Nazwa	Opis
AutoscaleSettings
CassandraPartitionKey	Klucz partycji tabeli Cassandra usługi Cosmos DB
CassandraSchema	Schemat tabeli Cassandra usługi Cosmos DB
CassandraTableGetResults	Tabela Cassandra usługi Azure Cosmos DB.
ClusterKey	Klucz klastra tabel Cassandra usługi Cosmos DB
Column	Kolumna tabeli Cassandra usługi Cosmos DB
Options
Resource

AutoscaleSettings

Nazwa	Typ	Opis
maxThroughput	integer	Reprezentuje maksymalną przepływność, zasób może być skalowany w górę do.

CassandraPartitionKey

Klucz partycji tabeli Cassandra usługi Cosmos DB

Nazwa	Typ	Opis
name	string	Nazwa klucza partycji tabeli Cassandra usługi Cosmos DB

CassandraSchema

Schemat tabeli Cassandra usługi Cosmos DB

Nazwa	Typ	Opis
clusterKeys	ClusterKey[]	Lista klucza klastra.
columns	Column[]	Lista kolumn tabeli Cassandra.
partitionKeys	CassandraPartitionKey[]	Lista klucza partycji.

CassandraTableGetResults

Tabela Cassandra usługi Azure Cosmos DB.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu usługi ARM.
location	string	Lokalizacja grupy zasobów, do której należy zasób.
name	string	Nazwa zasobu usługi ARM.
properties.options	Options
properties.resource	Resource
tags	object	Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB".
type	string	Typ zasobu platformy Azure.

ClusterKey

Klucz klastra tabel Cassandra usługi Cosmos DB

Nazwa	Typ	Opis
name	string	Nazwa klucza klastra tabel Cassandra usługi Cosmos DB
orderBy	string	Kolejność klucza klastra tabel Cassandra usługi Cosmos DB obsługują tylko "Asc" i "Desc"

Column

Kolumna tabeli Cassandra usługi Cosmos DB

Nazwa	Typ	Opis
name	string	Nazwa kolumny tabeli Cassandra usługi Cosmos DB
type	string	Typ kolumny tabeli Cassandra usługi Cosmos DB

Options

Nazwa	Typ	Opis
autoscaleSettings	AutoscaleSettings	Określa ustawienia autoskalu.
throughput	integer	Wartość przepływności zasobu usługi Cosmos DB lub autoskalowaniaUstawienia. Użyj zasobu PrzepływnośćUstawienia podczas pobierania szczegółów oferty.

Resource

Nazwa	Typ	Opis
_etag	string	Właściwość wygenerowana przez system reprezentująca tag zasobu wymagany dla optymistycznej kontrolki współbieżności.
_rid	string	Właściwość wygenerowana przez system. Unikatowy identyfikator.
_ts	number	Właściwość wygenerowana przez system, która określa ostatnią zaktualizowaną sygnaturę czasową zasobu.
analyticalStorageTtl	integer	Analityczny czas wygaśnięcia.
defaultTtl	integer	Czas wygaśnięcia tabeli Cassandra usługi Cosmos DB
id	string	Nazwa tabeli Cassandra usługi Cosmos DB
schema	CassandraSchema	Schemat tabeli Cassandra usługi Cosmos DB

Cassandra Resources - Get Cassandra Table

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

CosmosDBCassandraTableGet

Sample Request

Sample Response

Definicje

AutoscaleSettings

CassandraPartitionKey

CassandraSchema

CassandraTableGetResults

ClusterKey

Column

Options

Resource

Dodatkowe zasoby