1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getCassandraResourceCassandraKeyspace
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.20.1 published on Friday, Dec 1, 2023 by Pulumi

azure-native.documentdb.getCassandraResourceCassandraKeyspace

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.20.1 published on Friday, Dec 1, 2023 by Pulumi

    Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name. 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.

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:documentdb:getCassandraResourceCassandraKeyspace
      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.

    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.

    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.

    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.

    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.

    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.

    getCassandraResourceCassandraKeyspace 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.CassandraKeyspaceGetPropertiesResponseOptions
    Resource Pulumi.AzureNative.DocumentDB.Outputs.CassandraKeyspaceGetPropertiesResponseResource
    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 CassandraKeyspaceGetPropertiesResponseOptions
    Resource CassandraKeyspaceGetPropertiesResponseResource
    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 CassandraKeyspaceGetPropertiesResponseOptions
    resource CassandraKeyspaceGetPropertiesResponseResource
    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 CassandraKeyspaceGetPropertiesResponseOptions
    resource CassandraKeyspaceGetPropertiesResponseResource
    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 CassandraKeyspaceGetPropertiesResponseOptions
    resource CassandraKeyspaceGetPropertiesResponseResource
    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.

    CassandraKeyspaceGetPropertiesResponseOptions

    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.

    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
    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.20.1 published on Friday, Dec 1, 2023 by Pulumi