Microsoft.DocumentDB 数据库帐户/cassandraKeyspaces

• 最新
• 2025-11-01-预览
• 2025-10-15
• 2025-05-01-预览版
• 2025-04-15
• 2024-12-01-预览版
• 2024-11-15
• 2024-09-01-预览版
• 2024-08-15
• 2024-05-15
• 2024-05-15-预览版
• 2024-02-15-预览版
• 2023-11-15
• 2023-11-15-预览版
• 2023-09-15
• 2023-09-15-预览版
• 2023-04-15
• 2023-03-15
• 2023-03-15-预览版
• 2023-03-01-预览版
• 2022-11-15
• 2022-11-15-预览版
• 2022-08-15
• 2022-08-15-预览版
• 2022-05-15
• 2022-05-15-预览版
• 2022-02-15-预览版
• 2021-11-15-预览版
• 2021-10-15
• 2021-10-15-预览版
• 2021-07-01-预览版
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-预览版
• 2021-03-15
• 2021-03-01-预览版
• 2021-01-15
• 2020-09-01
• 2020-06-01-预览版
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 2019-08-01

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/cassandraKeyspaces 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces 资源，请将以下 Bicep 添加到模板。

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

属性值

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

名字	描述	价值
标识	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
父级	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：databaseAccounts
性能	用于创建和更新 Azure Cosmos DB Cassandra 密钥空间的属性。	CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties （必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

ARMResourceProperties标签

名字	描述	价值

AutoscaleSettings

名字	描述	价值
maxThroughput （最大吞吐量）	表示最大吞吐量，资源可以纵向扩展。	整数 (int)

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
资源	Cassandra 密钥空间的标准 JSON 格式	CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource（必需）

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

名字	描述	价值
身份证	Cosmos DB Cassandra 密钥空间的名称	string （必需）

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	整数 (int)

ManagedServiceIdentity

名字	描述	价值
类型	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
用户分配的标识	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

用法示例

Bicep 示例

在 Cosmos DB 帐户中部署 Cassandra KeySpace 的基本示例。

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: [
      {
        name: 'EnableCassandra'
      }
    ]
    consistencyPolicy: {
      defaultConsistencyLevel: 'Strong'
      maxIntervalInSeconds: 5
      maxStalenessPrefix: 100
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

resource cassandraKeyspace 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15' = {
  parent: databaseAccount
  name: resourceName
  properties: {
    options: {}
    resource: {
      id: 'acctest0001'
    }
  }
}

Azure 快速入门示例

以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。

Bicep 文件	描述
为 Cassandra API 创建 Azure Cosmos DB 帐户	此模板在具有密钥空间和具有专用吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。
为 Cassandra API 创建自动缩放 Azure Cosmos DB 帐户	此模板在具有密钥空间和具有自动缩放吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。

ARM 模板资源定义

可以使用目标操作部署 databaseAccounts/cassandraKeyspaces 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces 资源，请将以下 JSON 添加到模板。

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

属性值

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

名字	描述	价值
apiVersion	API 版本	“2025-11-01-预览”
标识	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
性能	用于创建和更新 Azure Cosmos DB Cassandra 密钥空间的属性。	CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties （必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces”

ARMResourceProperties标签

名字	描述	价值

AutoscaleSettings

名字	描述	价值
maxThroughput （最大吞吐量）	表示最大吞吐量，资源可以纵向扩展。	整数 (int)

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
资源	Cassandra 密钥空间的标准 JSON 格式	CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource（必需）

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

名字	描述	价值
身份证	Cosmos DB Cassandra 密钥空间的名称	string （必需）

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	整数 (int)

ManagedServiceIdentity

名字	描述	价值
类型	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
用户分配的标识	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

模板	描述
为 Cassandra API 创建 Azure Cosmos DB 帐户	此模板在具有密钥空间和具有专用吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。
为 Cassandra API 创建自动缩放 Azure Cosmos DB 帐户	此模板在具有密钥空间和具有自动缩放吞吐量的表的两个区域中为 Cassandra API 创建 Azure Cosmos DB 帐户。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 databaseAccounts/cassandraKeyspaces 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  }
}

属性值

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

名字	描述	价值
标识	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：databaseAccounts
性能	用于创建和更新 Azure Cosmos DB Cassandra 密钥空间的属性。	CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties （必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2025-11-01-preview”

ARMResourceProperties标签

名字	描述	价值

AutoscaleSettings

名字	描述	价值
maxThroughput （最大吞吐量）	表示最大吞吐量，资源可以纵向扩展。	整数 (int)

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
资源	Cassandra 密钥空间的标准 JSON 格式	CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource（必需）

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

名字	描述	价值
身份证	Cosmos DB Cassandra 密钥空间的名称	string （必需）

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。 注意：需要吞吐量或自动缩放设置，但不需要两者。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	整数 (int)

ManagedServiceIdentity

名字	描述	价值
类型	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
用户分配的标识	与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

用法示例

Terraform 示例

在 Cosmos DB 帐户中部署 Cassandra KeySpace 的基本示例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
        {
          name = "EnableCassandra"
        },
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "Strong"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "cassandraKeyspace" {
  type      = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}