你当前正在访问 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=2023-11-15
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
account
|
path | True |
string |
Cosmos DB 数据库帐户名称。 Regex pattern: |
keyspace
|
path | True |
string |
Cosmos DB 密钥空间名称。 |
resource
|
path | True |
string |
资源组的名称。 此名称不区分大小写。 |
subscription
|
path | True |
string |
目标订阅的 ID。 |
api-version
|
query | True |
string |
要用于此操作的 API 版本。 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
properties.resource | True |
Cassandra 密钥空间的标准 JSON 格式 |
|
location |
string |
资源所属的资源组的位置。 |
|
properties.options |
要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 |
||
tags |
object |
标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Cassandra 密钥空间创建或更新操作已成功完成。 |
|
202 Accepted |
Cassandra 密钥空间创建或更新操作将以异步方式完成。 Headers
|
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
CosmosDBCassandraKeyspaceCreateUpdate
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName?api-version=2023-11-15
{
"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"
}
}
}
定义
名称 | 说明 |
---|---|
Autoscale |
|
Cassandra |
用于创建和更新 Cosmos DB Cassandra 密钥空间的参数。 |
Cassandra |
Azure Cosmos DB Cassandra 密钥空间。 |
Cassandra |
Cosmos DB Cassandra keyspace 资源对象 |
Create |
CreateUpdateOptions 是描述资源的键值对的列表。 支持的密钥为“If-Match”、“If-None-Match”、“Session-Token”和“Throughput” |
Options | |
Resource |
AutoscaleSettings
名称 | 类型 | 说明 |
---|---|---|
maxThroughput |
integer |
表示资源可纵向扩展的最大吞吐量。 |
CassandraKeyspaceCreateUpdateParameters
用于创建和更新 Cosmos DB Cassandra 密钥空间的参数。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
ARM 资源的唯一资源标识符。 |
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 密钥空间。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
ARM 资源的唯一资源标识符。 |
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 资源对象
名称 | 类型 | 说明 |
---|---|---|
id |
string |
Cosmos DB Cassandra 密钥空间的名称 |
CreateUpdateOptions
CreateUpdateOptions 是描述资源的键值对的列表。 支持的密钥为“If-Match”、“If-None-Match”、“Session-Token”和“Throughput”
名称 | 类型 | 说明 |
---|---|---|
autoscaleSettings |
指定自动缩放设置。 注意:吞吐量或自动缩放设置是必需的,但不是两者兼而有之。 |
|
throughput |
integer |
每秒请求单位数。 例如,“吞吐量”:10000。 |
Options
名称 | 类型 | 说明 |
---|---|---|
autoscaleSettings |
指定自动缩放设置。 |
|
throughput |
integer |
Cosmos DB 资源吞吐量或自动缩放设置的值。 检索产品/服务详细信息时,请使用 ThroughputSetting 资源。 |
Resource
名称 | 类型 | 说明 |
---|---|---|
_etag |
string |
表示乐观并发控制所需的资源 etag 的系统生成的属性。 |
_rid |
string |
系统生成的属性。 唯一标识符。 |
_ts |
number |
一个系统生成的属性,表示资源的上次更新时间戳。 |
id |
string |
Cosmos DB Cassandra 密钥空间的名称 |