azure-native.cosmosdb.getCassandraResourceCassandraKeyspace
Explore with Pulumi AI
Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.
Uses Azure REST API version 2024-11-15.
Other available API versions: 2019-08-01, 2019-12-12, 2020-03-01, 2020-04-01, 2020-06-01-preview, 2020-09-01, 2021-01-15, 2021-03-01-preview, 2021-03-15, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 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, 2024-08-15, 2024-09-01-preview, 2024-12-01-preview. 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 getCassandraResourceCassandraKeyspace
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 getCassandraResourceCassandraKeyspace(args: GetCassandraResourceCassandraKeyspaceArgs, opts?: InvokeOptions): Promise<GetCassandraResourceCassandraKeyspaceResult>
function getCassandraResourceCassandraKeyspaceOutput(args: GetCassandraResourceCassandraKeyspaceOutputArgs, opts?: InvokeOptions): Output<GetCassandraResourceCassandraKeyspaceResult>def get_cassandra_resource_cassandra_keyspace(account_name: Optional[str] = None,
                                              keyspace_name: Optional[str] = None,
                                              resource_group_name: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetCassandraResourceCassandraKeyspaceResult
def get_cassandra_resource_cassandra_keyspace_output(account_name: Optional[pulumi.Input[str]] = None,
                                              keyspace_name: Optional[pulumi.Input[str]] = None,
                                              resource_group_name: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetCassandraResourceCassandraKeyspaceResult]func LookupCassandraResourceCassandraKeyspace(ctx *Context, args *LookupCassandraResourceCassandraKeyspaceArgs, opts ...InvokeOption) (*LookupCassandraResourceCassandraKeyspaceResult, error)
func LookupCassandraResourceCassandraKeyspaceOutput(ctx *Context, args *LookupCassandraResourceCassandraKeyspaceOutputArgs, opts ...InvokeOption) LookupCassandraResourceCassandraKeyspaceResultOutput> Note: This function is named LookupCassandraResourceCassandraKeyspace in the Go SDK.
public static class GetCassandraResourceCassandraKeyspace 
{
    public static Task<GetCassandraResourceCassandraKeyspaceResult> InvokeAsync(GetCassandraResourceCassandraKeyspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetCassandraResourceCassandraKeyspaceResult> Invoke(GetCassandraResourceCassandraKeyspaceInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCassandraResourceCassandraKeyspaceResult> getCassandraResourceCassandraKeyspace(GetCassandraResourceCassandraKeyspaceArgs args, InvokeOptions options)
public static Output<GetCassandraResourceCassandraKeyspaceResult> getCassandraResourceCassandraKeyspace(GetCassandraResourceCassandraKeyspaceArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:cosmosdb:getCassandraResourceCassandraKeyspace
  arguments:
    # arguments dictionaryThe 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.
 
- 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.
 
- 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.
 
- 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.
 
- 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.
 
- 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.
 
getCassandraResourceCassandraKeyspace Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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. Cosmos DB. Outputs. Cassandra Keyspace Get Properties Response Options  - Resource
Pulumi.
Azure Native. Cosmos DB. Outputs. Cassandra Keyspace 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".
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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
Keyspace Get Properties Response Options  - Resource
Cassandra
Keyspace 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".
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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
Keyspace Get Properties Response Options  - resource
Cassandra
Keyspace 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".
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - 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
Keyspace Get Properties Response Options  - resource
Cassandra
Keyspace 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".
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - 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
Keyspace Get Properties Response Options  - resource
Cassandra
Keyspace 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".
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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.
 
CassandraKeyspaceGetPropertiesResponseOptions     
- Autoscale
Settings Pulumi.Azure Native. Cosmos 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.
 
CassandraKeyspaceGetPropertiesResponseResource     
- Etag string
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - Id string
 - Name of the Cosmos DB Cassandra keyspace
 - Rid string
 - A system generated property. A unique identifier.
 - Ts double
 - A system generated property that denotes the last updated timestamp of the resource.
 
- Etag string
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - Id string
 - Name of the Cosmos DB Cassandra keyspace
 - Rid string
 - A system generated property. A unique identifier.
 - Ts float64
 - A system generated property that denotes the last updated timestamp of the resource.
 
- etag String
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - id String
 - Name of the Cosmos DB Cassandra keyspace
 - rid String
 - A system generated property. A unique identifier.
 - ts Double
 - A system generated property that denotes the last updated timestamp of the resource.
 
- etag string
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - id string
 - Name of the Cosmos DB Cassandra keyspace
 - rid string
 - A system generated property. A unique identifier.
 - ts number
 - A system generated property that denotes the last updated timestamp of the resource.
 
- etag str
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - id str
 - Name of the Cosmos DB Cassandra keyspace
 - rid str
 - A system generated property. A unique identifier.
 - ts float
 - A system generated property that denotes the last updated timestamp of the resource.
 
- etag String
 - A system generated property representing the resource etag required for optimistic concurrency control.
 - id String
 - Name of the Cosmos DB Cassandra keyspace
 - rid String
 - A system generated property. A unique identifier.
 - ts Number
 - A system generated property that denotes the last updated timestamp of the resource.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0