Share via

Microsoft.DocumentDB databaseAccounts/cassandraKeyspaces/views 2024-09-01-preview

  • Article

Bicep resource definition

The databaseAccounts/cassandraKeyspaces/views resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2024-09-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
      viewDefinition: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CassandraViewCreateUpdatePropertiesOrCassandraViewGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrCassandraViewGetPropertiesOptions
resource The standard JSON format of a Cassandra view CassandraViewResourceOrCassandraViewGetPropertiesResource (required)

CassandraViewResourceOrCassandraViewGetPropertiesResource

Name Description Value
id Name of the Cosmos DB Cassandra view string (required)
viewDefinition View Definition of the Cosmos DB Cassandra view string (required)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

CreateUpdateOptionsOrCassandraViewGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

ManagedServiceIdentity

Name Description Value
type 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. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views

Name Description Value
identity Identity for the resource. ManagedServiceIdentity
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databaseAccounts/cassandraKeyspaces
properties Properties to create and update Azure Cosmos DB Cassandra view. CassandraViewCreateUpdatePropertiesOrCassandraViewGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

Tags

Name Description Value

ARM template resource definition

The databaseAccounts/cassandraKeyspaces/views resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views",
  "apiVersion": "2024-09-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string",
      "viewDefinition": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CassandraViewCreateUpdatePropertiesOrCassandraViewGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrCassandraViewGetPropertiesOptions
resource The standard JSON format of a Cassandra view CassandraViewResourceOrCassandraViewGetPropertiesResource (required)

CassandraViewResourceOrCassandraViewGetPropertiesResource

Name Description Value
id Name of the Cosmos DB Cassandra view string (required)
viewDefinition View Definition of the Cosmos DB Cassandra view string (required)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

CreateUpdateOptionsOrCassandraViewGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

ManagedServiceIdentity

Name Description Value
type 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. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views

Name Description Value
apiVersion The api version '2024-09-01-preview'
identity Identity for the resource. ManagedServiceIdentity
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
properties Properties to create and update Azure Cosmos DB Cassandra view. CassandraViewCreateUpdatePropertiesOrCassandraViewGetProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views'

Tags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The databaseAccounts/cassandraKeyspaces/views resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2024-09-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
        viewDefinition = "string"
      }
    }
  })
}

Property Values

AutoscaleSettings

Name Description Value
maxThroughput Represents maximum throughput, the resource can scale up to. int

CassandraViewCreateUpdatePropertiesOrCassandraViewGetProperties

Name Description Value
options A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request. CreateUpdateOptionsOrCassandraViewGetPropertiesOptions
resource The standard JSON format of a Cassandra view CassandraViewResourceOrCassandraViewGetPropertiesResource (required)

CassandraViewResourceOrCassandraViewGetPropertiesResource

Name Description Value
id Name of the Cosmos DB Cassandra view string (required)
viewDefinition View Definition of the Cosmos DB Cassandra view string (required)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Name Description Value

CreateUpdateOptionsOrCassandraViewGetPropertiesOptions

Name Description Value
autoscaleSettings Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not both. AutoscaleSettings
throughput Request Units per second. For example, "throughput": 10000. int

ManagedServiceIdentity

Name Description Value
type 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. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities 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}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Description Value

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views

Name Description Value
identity Identity for the resource. ManagedServiceIdentity
location The location of the resource group to which the resource belongs. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts/cassandraKeyspaces
properties Properties to create and update Azure Cosmos DB Cassandra view. CassandraViewCreateUpdatePropertiesOrCassandraViewGetProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views@2024-09-01-preview"

Tags

Name Description Value