你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Cassandra Resources - Create Update Cassandra Keyspace

创建或更新 Azure Cosmos DB Cassandra 密钥空间

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}?api-version=2021-04-01-preview

URI 参数

Name In Required Type Description
accountName
path True
  • string

Cosmos DB 数据库帐户名称。

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

keyspaceName
path True
  • string

Cosmos DB 密钥空间名称。

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

请求正文

Name Required Type Description
properties.resource True

Cassandra 键空间的标准 JSON 格式

identity

资源的标识。

location
  • string

资源所属的资源组的位置。

properties.options

要应用于请求的选项的键值对。 这对应于随请求一起发送的标头。

tags
  • object

标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

响应

Name Type Description
200 OK

Cassandra 密钥空间创建或更新操作已成功完成。

202 Accepted

Cassandra 密钥空间创建或更新操作将异步完成。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

CosmosDBCassandraKeyspaceCreateUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName?api-version=2021-04-01-preview

{
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "keyspaceName"
    },
    "options": {}
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName",
  "name": "keyspaceName",
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "id": "keyspaceName"
    }
  }
}

定义

AutoscaleSettings
CassandraKeyspaceCreateUpdateParameters

用于创建和更新 Cosmos DB Cassandra 密钥空间的参数。

CassandraKeyspaceGetResults

Azure Cosmos DB Cassandra 密钥空间。

CassandraKeyspaceResource

Cosmos DB Cassandra keyspace 资源对象

CreateUpdateOptions

CreateUpdateOptions 是描述资源的键值对的列表。 支持的密钥为“If-Match”、“If-None-Match”、“Session-Token”和“吞吐量”

ManagedServiceIdentity

资源的标识。

Options
Resource
ResourceIdentityType

用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

AutoscaleSettings

Name Type Description
maxThroughput
  • integer

表示最大吞吐量,资源可纵向扩展。

CassandraKeyspaceCreateUpdateParameters

用于创建和更新 Cosmos DB Cassandra 密钥空间的参数。

Name Type Description
id
  • string

ARM 资源的唯一资源标识符。

identity

资源的标识。

location
  • string

资源所属的资源组的位置。

name
  • string

ARM 资源的名称。

properties.options

要应用于请求的选项的键值对。 这对应于随请求一起发送的标头。

properties.resource

Cassandra 键空间的标准 JSON 格式

tags
  • object

标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

type
  • string

Azure 资源的类型。

CassandraKeyspaceGetResults

Azure Cosmos DB Cassandra 密钥空间。

Name Type Description
id
  • string

ARM 资源的唯一资源标识符。

identity

资源的标识。

location
  • string

资源所属的资源组的位置。

name
  • string

ARM 资源的名称。

properties.options
properties.resource
tags
  • object

标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。

type
  • string

Azure 资源的类型。

CassandraKeyspaceResource

Cosmos DB Cassandra keyspace 资源对象

Name Type Description
id
  • string

Cosmos DB Cassandra 密钥空间的名称

CreateUpdateOptions

CreateUpdateOptions 是描述资源的键值对的列表。 支持的密钥为“If-Match”、“If-None-Match”、“Session-Token”和“吞吐量”

Name Type Description
autoscaleSettings

指定自动缩放设置。

throughput
  • integer

每秒请求单位数。 例如,“吞吐量”:10000。

ManagedServiceIdentity

资源的标识。

Name Type Description
principalId
  • string

系统分配标识的主体 ID。 此属性仅适用于系统分配的标识。

tenantId
  • string

系统分配标识的租户 ID。 此属性仅适用于系统分配的标识。

type

用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

userAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

Options

Name Type Description
autoscaleSettings

指定自动缩放设置。

throughput
  • integer

Cosmos DB 资源吞吐量或自动缩放设置的值。 检索产品/服务详细信息时,请使用 ThroughputSetting 资源。

Resource

Name Type Description
_etag
  • string

表示乐观并发控制所需的资源 etag 的系统生成属性。

_rid
  • string

系统生成的属性。 唯一标识符。

_ts
  • number

一个系统生成的属性,表示资源上次更新的时间戳。

id
  • string

Cosmos DB Cassandra 密钥空间的名称

ResourceIdentityType

用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

UserAssignedIdentities

与资源关联的用户标识列表。 用户标识字典密钥引用的格式为 ARM 资源 ID:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

Name Type Description