azure-native.documentdb.getCassandraResourceCassandraTable
Explore with Pulumi AI
Gets the Cassandra table under an existing Azure Cosmos DB database account. Azure REST API version: 2023-04-15.
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:
- Account
Name string Cosmos DB database account name.
- Keyspace
Name string Cosmos DB keyspace name.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Table
Name string Cosmos DB table name.
- Account
Name string Cosmos DB database account name.
- Keyspace
Name string Cosmos DB keyspace name.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Table
Name string Cosmos DB table name.
- account
Name String Cosmos DB database account name.
- keyspace
Name String Cosmos DB keyspace name.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- table
Name String Cosmos DB table name.
- account
Name string Cosmos DB database account name.
- keyspace
Name string Cosmos DB keyspace name.
- resource
Group stringName The name of the resource group. The name is case insensitive.
- table
Name string Cosmos DB table name.
- account_
name str Cosmos DB database account name.
- keyspace_
name str Cosmos DB keyspace name.
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- table_
name str Cosmos DB table name.
- account
Name String Cosmos DB database account name.
- keyspace
Name String Cosmos DB keyspace name.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- table
Name 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.
Azure Native. Document DB. Outputs. Cassandra Table Get Properties Response Options - Resource
Pulumi.
Azure Native. Document DB. Outputs. Cassandra Table Get Properties Response Resource - 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
Cassandra
Table Get Properties Response Options - Resource
Cassandra
Table Get Properties Response Resource - 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
Cassandra
Table Get Properties Response Options - resource
Cassandra
Table Get Properties Response Resource - 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
Cassandra
Table Get Properties Response Options - resource
Cassandra
Table Get Properties Response Resource - {[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
Cassandra
Table Get Properties Response Options - resource
Cassandra
Table Get Properties Response Resource - 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
- 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
- Max
Throughput int Represents maximum throughput, the resource can scale up to.
- Max
Throughput int Represents maximum throughput, the resource can scale up to.
- max
Throughput Integer Represents maximum throughput, the resource can scale up to.
- max
Throughput number Represents maximum throughput, the resource can scale up to.
- max_
throughput int Represents maximum throughput, the resource can scale up to.
- max
Throughput 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
- Cluster
Keys List<Pulumi.Azure Native. Document DB. Inputs. Cluster Key Response> List of cluster key.
- Columns
List<Pulumi.
Azure Native. Document DB. Inputs. Column Response> List of Cassandra table columns.
- Partition
Keys List<Pulumi.Azure Native. Document DB. Inputs. Cassandra Partition Key Response> List of partition key.
- Cluster
Keys []ClusterKey Response List of cluster key.
- Columns
[]Column
Response List of Cassandra table columns.
- Partition
Keys []CassandraPartition Key Response List of partition key.
- cluster
Keys List<ClusterKey Response> List of cluster key.
- columns
List<Column
Response> List of Cassandra table columns.
- partition
Keys List<CassandraPartition Key Response> List of partition key.
- cluster
Keys ClusterKey Response[] List of cluster key.
- columns
Column
Response[] List of Cassandra table columns.
- partition
Keys CassandraPartition Key Response[] List of partition key.
- cluster_
keys Sequence[ClusterKey Response] List of cluster key.
- columns
Sequence[Column
Response] List of Cassandra table columns.
- partition_
keys Sequence[CassandraPartition Key Response] List of partition key.
- cluster
Keys List<Property Map> List of cluster key.
- columns List<Property Map>
List of Cassandra table columns.
- partition
Keys List<Property Map> List of partition key.
CassandraTableGetPropertiesResponseOptions
- Autoscale
Settings Pulumi.Azure Native. Document DB. Inputs. Autoscale Settings Response Specifies the Autoscale settings.
- Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- Autoscale
Settings AutoscaleSettings Response Specifies the Autoscale settings.
- Throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response Specifies the Autoscale settings.
- throughput Integer
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings AutoscaleSettings Response 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 AutoscaleSettings Response Specifies the Autoscale settings.
- throughput int
Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details.
- autoscale
Settings 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.
- Analytical
Storage intTtl Analytical TTL.
- Default
Ttl int Time to live of the Cosmos DB Cassandra table
- Schema
Pulumi.
Azure Native. Document DB. Inputs. Cassandra Schema Response 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.
- Analytical
Storage intTtl Analytical TTL.
- Default
Ttl int Time to live of the Cosmos DB Cassandra table
- Schema
Cassandra
Schema Response 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.
- analytical
Storage IntegerTtl Analytical TTL.
- default
Ttl Integer Time to live of the Cosmos DB Cassandra table
- schema
Cassandra
Schema Response 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.
- analytical
Storage numberTtl Analytical TTL.
- default
Ttl number Time to live of the Cosmos DB Cassandra table
- schema
Cassandra
Schema Response 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_ intttl Analytical TTL.
- default_
ttl int Time to live of the Cosmos DB Cassandra table
- schema
Cassandra
Schema Response 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.
- analytical
Storage NumberTtl Analytical TTL.
- default
Ttl Number Time to live of the Cosmos DB Cassandra table
- schema Property Map
Schema of the Cosmos DB Cassandra table
ClusterKeyResponse
ColumnResponse
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0