Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getCassandraResourceCassandraTable
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.documentdb.getCassandraResourceCassandraTable

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure-native

    Gets the Cassandra table under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15.

    Other available API versions: 2019-08-01, 2023-03-15-preview, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview.

    Using getCassandraResourceCassandraTable

    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 getCassandraResourceCassandraTable(args: GetCassandraResourceCassandraTableArgs, opts?: InvokeOptions): Promise<GetCassandraResourceCassandraTableResult>
function getCassandraResourceCassandraTableOutput(args: GetCassandraResourceCassandraTableOutputArgs, opts?: InvokeOptions): Output<GetCassandraResourceCassandraTableResult>
    def get_cassandra_resource_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) -> GetCassandraResourceCassandraTableResult
def get_cassandra_resource_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[GetCassandraResourceCassandraTableResult]
    func LookupCassandraResourceCassandraTable(ctx *Context, args *LookupCassandraResourceCassandraTableArgs, opts ...InvokeOption) (*LookupCassandraResourceCassandraTableResult, error)
func LookupCassandraResourceCassandraTableOutput(ctx *Context, args *LookupCassandraResourceCassandraTableOutputArgs, opts ...InvokeOption) LookupCassandraResourceCassandraTableResultOutput

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

    public static class GetCassandraResourceCassandraTable 
{
    public static Task<GetCassandraResourceCassandraTableResult> InvokeAsync(GetCassandraResourceCassandraTableArgs args, InvokeOptions? opts = null)
    public static Output<GetCassandraResourceCassandraTableResult> Invoke(GetCassandraResourceCassandraTableInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCassandraResourceCassandraTableResult> getCassandraResourceCassandraTable(GetCassandraResourceCassandraTableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:documentdb:getCassandraResourceCassandraTable
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountName string
    Cosmos DB database account name.
    KeyspaceName string
    Cosmos DB keyspace name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TableName string
    Cosmos DB table name.
    AccountName string
    Cosmos DB database account name.
    KeyspaceName string
    Cosmos DB keyspace name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TableName string
    Cosmos DB table name.
    accountName String
    Cosmos DB database account name.
    keyspaceName String
    Cosmos DB keyspace name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    tableName String
    Cosmos DB table name.
    accountName string
    Cosmos DB database account name.
    keyspaceName string
    Cosmos DB keyspace name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    tableName string
    Cosmos DB table name.
    account_name str
    Cosmos DB database account name.
    keyspace_name str
    Cosmos DB keyspace name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    table_name str
    Cosmos DB table name.
    accountName String
    Cosmos DB database account name.
    keyspaceName String
    Cosmos DB keyspace name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    tableName String
    Cosmos DB table name.

    getCassandraResourceCassandraTable Result

    The following output properties are available:

    Id string
    The unique resource identifier of the ARM resource.
    Name string
    The name of the ARM resource.
    Type string
    The type of Azure resource.
    Location string
    The location of the resource group to which the resource belongs.
    Options Pulumi.AzureNative.DocumentDB.Outputs.CassandraTableGetPropertiesResponseOptions
    Resource Pulumi.AzureNative.DocumentDB.Outputs.CassandraTableGetPropertiesResponseResource
    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".
    Id string
    The unique resource identifier of the ARM resource.
    Name string
    The name of the ARM resource.
    Type string
    The type of Azure resource.
    Location string
    The location of the resource group to which the resource belongs.
    Options CassandraTableGetPropertiesResponseOptions
    Resource CassandraTableGetPropertiesResponseResource
    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".
    id String
    The unique resource identifier of the ARM resource.
    name String
    The name of the ARM resource.
    type String
    The type of Azure resource.
    location String
    The location of the resource group to which the resource belongs.
    options CassandraTableGetPropertiesResponseOptions
    resource CassandraTableGetPropertiesResponseResource
    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".
    id string
    The unique resource identifier of the ARM resource.
    name string
    The name of the ARM resource.
    type string
    The type of Azure resource.
    location string
    The location of the resource group to which the resource belongs.
    options CassandraTableGetPropertiesResponseOptions
    resource CassandraTableGetPropertiesResponseResource
    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".
    id str
    The unique resource identifier of the ARM resource.
    name str
    The name of the ARM resource.
    type str
    The type of Azure resource.
    location str
    The location of the resource group to which the resource belongs.
    options CassandraTableGetPropertiesResponseOptions
    resource CassandraTableGetPropertiesResponseResource
    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".
    id String
    The unique resource identifier of the ARM resource.
    name String
    The name of the ARM resource.
    type String
    The type of Azure resource.
    location String
    The location of the resource group to which the resource belongs.
    options Property Map
    resource Property Map
    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

    AutoscaleSettingsResponse

    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    MaxThroughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Integer
    Represents maximum throughput, the resource can scale up to.
    maxThroughput number
    Represents maximum throughput, the resource can scale up to.
    max_throughput int
    Represents maximum throughput, the resource can scale up to.
    maxThroughput Number
    Represents maximum throughput, the resource can scale up to.

    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.

    CassandraTableGetPropertiesResponseOptions

    AutoscaleSettings Pulumi.AzureNative.DocumentDB.Inputs.AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    Throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    AutoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    Throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput Integer
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput number
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscale_settings AutoscaleSettingsResponse
    Specifies the Autoscale settings.
    throughput int
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
    autoscaleSettings Property Map
    Specifies the Autoscale settings.
    throughput Number
    Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.

    CassandraTableGetPropertiesResponseResource

    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB Cassandra table
    Rid string
    A system generated property. A unique identifier.
    Ts double
    A system generated property that denotes the last updated timestamp of the resource.
    AnalyticalStorageTtl int
    Analytical TTL.
    DefaultTtl int
    Time to live of the Cosmos DB Cassandra table
    Schema Pulumi.AzureNative.DocumentDB.Inputs.CassandraSchemaResponse
    Schema of the Cosmos DB Cassandra table
    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB Cassandra table
    Rid string
    A system generated property. A unique identifier.
    Ts float64
    A system generated property that denotes the last updated timestamp of the resource.
    AnalyticalStorageTtl int
    Analytical TTL.
    DefaultTtl int
    Time to live of the Cosmos DB Cassandra table
    Schema CassandraSchemaResponse
    Schema of the Cosmos DB Cassandra table
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    id String
    Name of the Cosmos DB Cassandra table
    rid String
    A system generated property. A unique identifier.
    ts Double
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl Integer
    Analytical TTL.
    defaultTtl Integer
    Time to live of the Cosmos DB Cassandra table
    schema CassandraSchemaResponse
    Schema of the Cosmos DB Cassandra table
    etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    id string
    Name of the Cosmos DB Cassandra table
    rid string
    A system generated property. A unique identifier.
    ts number
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl number
    Analytical TTL.
    defaultTtl number
    Time to live of the Cosmos DB Cassandra table
    schema CassandraSchemaResponse
    Schema of the Cosmos DB Cassandra table
    etag str
    A system generated property representing the resource etag required for optimistic concurrency control.
    id str
    Name of the Cosmos DB Cassandra table
    rid str
    A system generated property. A unique identifier.
    ts float
    A system generated property that denotes the last updated timestamp of the resource.
    analytical_storage_ttl int
    Analytical TTL.
    default_ttl int
    Time to live of the Cosmos DB Cassandra table
    schema CassandraSchemaResponse
    Schema of the Cosmos DB Cassandra table
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    id String
    Name of the Cosmos DB Cassandra table
    rid String
    A system generated property. A unique identifier.
    ts Number
    A system generated property that denotes the last updated timestamp of the resource.
    analyticalStorageTtl Number
    Analytical TTL.
    defaultTtl Number
    Time to live of the Cosmos DB Cassandra table
    schema Property Map
    Schema of the Cosmos DB Cassandra table

    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.47.1 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure-native