Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cosmosdb
  5. getDatabaseAccountCassandraTable
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cosmosdb.getDatabaseAccountCassandraTable

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

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

Uses Azure REST API version 2016-03-31.

Other available API versions: 2015-04-01, 2015-04-08, 2015-11-06, 2016-03-19. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]. See the version guide for details.

Using getDatabaseAccountCassandraTable

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDatabaseAccountCassandraTable(args: GetDatabaseAccountCassandraTableArgs, opts?: InvokeOptions): Promise<GetDatabaseAccountCassandraTableResult>
function getDatabaseAccountCassandraTableOutput(args: GetDatabaseAccountCassandraTableOutputArgs, opts?: InvokeOptions): Output<GetDatabaseAccountCassandraTableResult>
Copy
def get_database_account_cassandra_table(account_name: Optional[str] = None,
                                         keyspace_name: Optional[str] = None,
                                         resource_group_name: Optional[str] = None,
                                         table_name: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetDatabaseAccountCassandraTableResult
def get_database_account_cassandra_table_output(account_name: Optional[pulumi.Input[str]] = None,
                                         keyspace_name: Optional[pulumi.Input[str]] = None,
                                         resource_group_name: Optional[pulumi.Input[str]] = None,
                                         table_name: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseAccountCassandraTableResult]
Copy
func LookupDatabaseAccountCassandraTable(ctx *Context, args *LookupDatabaseAccountCassandraTableArgs, opts ...InvokeOption) (*LookupDatabaseAccountCassandraTableResult, error)
func LookupDatabaseAccountCassandraTableOutput(ctx *Context, args *LookupDatabaseAccountCassandraTableOutputArgs, opts ...InvokeOption) LookupDatabaseAccountCassandraTableResultOutput
Copy

> Note: This function is named LookupDatabaseAccountCassandraTable in the Go SDK.

public static class GetDatabaseAccountCassandraTable 
{
    public static Task<GetDatabaseAccountCassandraTableResult> InvokeAsync(GetDatabaseAccountCassandraTableArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseAccountCassandraTableResult> Invoke(GetDatabaseAccountCassandraTableInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDatabaseAccountCassandraTableResult> getDatabaseAccountCassandraTable(GetDatabaseAccountCassandraTableArgs args, InvokeOptions options)
public static Output<GetDatabaseAccountCassandraTableResult> getDatabaseAccountCassandraTable(GetDatabaseAccountCassandraTableArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cosmosdb:getDatabaseAccountCassandraTable
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
KeyspaceName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB keyspace name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
TableName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB table name.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
KeyspaceName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB keyspace name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
TableName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB table name.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
keyspaceName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB keyspace name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.
tableName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB table name.
accountName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB database account name.
keyspaceName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB keyspace name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of an Azure resource group.
tableName
This property is required.
Changes to this property will trigger replacement.
string
Cosmos DB table name.
account_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB database account name.
keyspace_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB keyspace name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of an Azure resource group.
table_name
This property is required.
Changes to this property will trigger replacement.
str
Cosmos DB table name.
accountName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB database account name.
keyspaceName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB keyspace name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of an Azure resource group.
tableName
This property is required.
Changes to this property will trigger replacement.
String
Cosmos DB table name.

getDatabaseAccountCassandraTable Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
The unique resource identifier of the database account.
Name string
The name of the database account.
Type string
The type of Azure resource.
DefaultTtl int
Time to live of the Cosmos DB Cassandra table
Location string
The location of the resource group to which the resource belongs.
Schema Pulumi.AzureNative.CosmosDB.Outputs.CassandraSchemaResponse
Schema of the Cosmos DB Cassandra table
Tags Dictionary<string, string>
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".
AzureApiVersion string
The Azure API version of the resource.
Id string
The unique resource identifier of the database account.
Name string
The name of the database account.
Type string
The type of Azure resource.
DefaultTtl int
Time to live of the Cosmos DB Cassandra table
Location string
The location of the resource group to which the resource belongs.
Schema CassandraSchemaResponse
Schema of the Cosmos DB Cassandra table
Tags map[string]string
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".
azureApiVersion String
The Azure API version of the resource.
id String
The unique resource identifier of the database account.
name String
The name of the database account.
type String
The type of Azure resource.
defaultTtl Integer
Time to live of the Cosmos DB Cassandra table
location String
The location of the resource group to which the resource belongs.
schema CassandraSchemaResponse
Schema of the Cosmos DB Cassandra table
tags Map<String,String>
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".
azureApiVersion string
The Azure API version of the resource.
id string
The unique resource identifier of the database account.
name string
The name of the database account.
type string
The type of Azure resource.
defaultTtl number
Time to live of the Cosmos DB Cassandra table
location string
The location of the resource group to which the resource belongs.
schema CassandraSchemaResponse
Schema of the Cosmos DB Cassandra table
tags {[key: string]: string}
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".
azure_api_version str
The Azure API version of the resource.
id str
The unique resource identifier of the database account.
name str
The name of the database account.
type str
The type of Azure resource.
default_ttl int
Time to live of the Cosmos DB Cassandra table
location str
The location of the resource group to which the resource belongs.
schema CassandraSchemaResponse
Schema of the Cosmos DB Cassandra table
tags Mapping[str, str]
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".
azureApiVersion String
The Azure API version of the resource.
id String
The unique resource identifier of the database account.
name String
The name of the database account.
type String
The type of Azure resource.
defaultTtl Number
Time to live of the Cosmos DB Cassandra table
location String
The location of the resource group to which the resource belongs.
schema Property Map
Schema of the Cosmos DB Cassandra table
tags Map<String>
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".

Supporting Types

CassandraPartitionKeyResponse

Name string
Name of the Cosmos DB Cassandra table partition key
Name string
Name of the Cosmos DB Cassandra table partition key
name String
Name of the Cosmos DB Cassandra table partition key
name string
Name of the Cosmos DB Cassandra table partition key
name str
Name of the Cosmos DB Cassandra table partition key
name String
Name of the Cosmos DB Cassandra table partition key

CassandraSchemaResponse

ClusterKeys []ClusterKeyResponse
List of cluster key.
Columns []ColumnResponse
List of Cassandra table columns.
PartitionKeys []CassandraPartitionKeyResponse
List of partition key.
clusterKeys List<ClusterKeyResponse>
List of cluster key.
columns List<ColumnResponse>
List of Cassandra table columns.
partitionKeys List<CassandraPartitionKeyResponse>
List of partition key.
clusterKeys ClusterKeyResponse[]
List of cluster key.
columns ColumnResponse[]
List of Cassandra table columns.
partitionKeys CassandraPartitionKeyResponse[]
List of partition key.
clusterKeys List<Property Map>
List of cluster key.
columns List<Property Map>
List of Cassandra table columns.
partitionKeys List<Property Map>
List of partition key.

ClusterKeyResponse

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"
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"
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"
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"
name str
Name of the Cosmos DB Cassandra table cluster key
order_by str
Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc"
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"

ColumnResponse

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native