1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  5. getCassandraResourceCassandraView
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.documentdb.getCassandraResourceCassandraView

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.37.0 published on Monday, Apr 15, 2024 by Pulumi

    Gets the Cassandra view under an existing Azure Cosmos DB database account. Azure REST API version: 2023-03-15-preview.

    Other available API versions: 2023-09-15-preview, 2023-11-15-preview, 2024-02-15-preview.

    Using getCassandraResourceCassandraView

    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 getCassandraResourceCassandraView(args: GetCassandraResourceCassandraViewArgs, opts?: InvokeOptions): Promise<GetCassandraResourceCassandraViewResult>
    function getCassandraResourceCassandraViewOutput(args: GetCassandraResourceCassandraViewOutputArgs, opts?: InvokeOptions): Output<GetCassandraResourceCassandraViewResult>
    def get_cassandra_resource_cassandra_view(account_name: Optional[str] = None,
                                              keyspace_name: Optional[str] = None,
                                              resource_group_name: Optional[str] = None,
                                              view_name: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetCassandraResourceCassandraViewResult
    def get_cassandra_resource_cassandra_view_output(account_name: Optional[pulumi.Input[str]] = None,
                                              keyspace_name: Optional[pulumi.Input[str]] = None,
                                              resource_group_name: Optional[pulumi.Input[str]] = None,
                                              view_name: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetCassandraResourceCassandraViewResult]
    func LookupCassandraResourceCassandraView(ctx *Context, args *LookupCassandraResourceCassandraViewArgs, opts ...InvokeOption) (*LookupCassandraResourceCassandraViewResult, error)
    func LookupCassandraResourceCassandraViewOutput(ctx *Context, args *LookupCassandraResourceCassandraViewOutputArgs, opts ...InvokeOption) LookupCassandraResourceCassandraViewResultOutput

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

    public static class GetCassandraResourceCassandraView 
    {
        public static Task<GetCassandraResourceCassandraViewResult> InvokeAsync(GetCassandraResourceCassandraViewArgs args, InvokeOptions? opts = null)
        public static Output<GetCassandraResourceCassandraViewResult> Invoke(GetCassandraResourceCassandraViewInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCassandraResourceCassandraViewResult> getCassandraResourceCassandraView(GetCassandraResourceCassandraViewArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:documentdb:getCassandraResourceCassandraView
      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.
    ViewName string
    Cosmos DB view 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.
    ViewName string
    Cosmos DB view 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.
    viewName String
    Cosmos DB view 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.
    viewName string
    Cosmos DB view 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.
    view_name str
    Cosmos DB view 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.
    viewName String
    Cosmos DB view name.

    getCassandraResourceCassandraView 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.
    Identity Pulumi.AzureNative.DocumentDB.Outputs.ManagedServiceIdentityResponse
    Identity for the resource.
    Location string
    The location of the resource group to which the resource belongs.
    Options Pulumi.AzureNative.DocumentDB.Outputs.CassandraViewGetPropertiesResponseOptions
    Resource Pulumi.AzureNative.DocumentDB.Outputs.CassandraViewGetPropertiesResponseResource
    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.
    Identity ManagedServiceIdentityResponse
    Identity for the resource.
    Location string
    The location of the resource group to which the resource belongs.
    Options CassandraViewGetPropertiesResponseOptions
    Resource CassandraViewGetPropertiesResponseResource
    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.
    identity ManagedServiceIdentityResponse
    Identity for the resource.
    location String
    The location of the resource group to which the resource belongs.
    options CassandraViewGetPropertiesResponseOptions
    resource CassandraViewGetPropertiesResponseResource
    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.
    identity ManagedServiceIdentityResponse
    Identity for the resource.
    location string
    The location of the resource group to which the resource belongs.
    options CassandraViewGetPropertiesResponseOptions
    resource CassandraViewGetPropertiesResponseResource
    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.
    identity ManagedServiceIdentityResponse
    Identity for the resource.
    location str
    The location of the resource group to which the resource belongs.
    options CassandraViewGetPropertiesResponseOptions
    resource CassandraViewGetPropertiesResponseResource
    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.
    identity Property Map
    Identity for the 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.

    CassandraViewGetPropertiesResponseOptions

    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.

    CassandraViewGetPropertiesResponseResource

    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB Cassandra view
    Rid string
    A system generated property. A unique identifier.
    Ts double
    A system generated property that denotes the last updated timestamp of the resource.
    ViewDefinition string
    View Definition of the Cosmos DB Cassandra view
    Etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    Id string
    Name of the Cosmos DB Cassandra view
    Rid string
    A system generated property. A unique identifier.
    Ts float64
    A system generated property that denotes the last updated timestamp of the resource.
    ViewDefinition string
    View Definition of the Cosmos DB Cassandra view
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    id String
    Name of the Cosmos DB Cassandra view
    rid String
    A system generated property. A unique identifier.
    ts Double
    A system generated property that denotes the last updated timestamp of the resource.
    viewDefinition String
    View Definition of the Cosmos DB Cassandra view
    etag string
    A system generated property representing the resource etag required for optimistic concurrency control.
    id string
    Name of the Cosmos DB Cassandra view
    rid string
    A system generated property. A unique identifier.
    ts number
    A system generated property that denotes the last updated timestamp of the resource.
    viewDefinition string
    View Definition of the Cosmos DB Cassandra view
    etag str
    A system generated property representing the resource etag required for optimistic concurrency control.
    id str
    Name of the Cosmos DB Cassandra view
    rid str
    A system generated property. A unique identifier.
    ts float
    A system generated property that denotes the last updated timestamp of the resource.
    view_definition str
    View Definition of the Cosmos DB Cassandra view
    etag String
    A system generated property representing the resource etag required for optimistic concurrency control.
    id String
    Name of the Cosmos DB Cassandra view
    rid String
    A system generated property. A unique identifier.
    ts Number
    A system generated property that denotes the last updated timestamp of the resource.
    viewDefinition String
    View Definition of the Cosmos DB Cassandra view

    ManagedServiceIdentityResponse

    PrincipalId string
    The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.DocumentDB.Inputs.ManagedServiceIdentityResponseUserAssignedIdentities>
    The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    PrincipalId string
    The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
    UserAssignedIdentities map[string]ManagedServiceIdentityResponseUserAssignedIdentities
    The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId String
    The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
    userAssignedIdentities Map<String,ManagedServiceIdentityResponseUserAssignedIdentities>
    The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId string
    The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
    type string
    The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
    userAssignedIdentities {[key: string]: ManagedServiceIdentityResponseUserAssignedIdentities}
    The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principal_id str
    The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
    type str
    The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
    user_assigned_identities Mapping[str, ManagedServiceIdentityResponseUserAssignedIdentities]
    The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    principalId String
    The principal id of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant id of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.
    userAssignedIdentities Map<Property Map>
    The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

    ManagedServiceIdentityResponseUserAssignedIdentities

    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.
    clientId string
    The client id of user assigned identity.
    principalId string
    The principal id of user assigned identity.
    client_id str
    The client id of user assigned identity.
    principal_id str
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.

    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.37.0 published on Monday, Apr 15, 2024 by Pulumi