你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Bicep 资源定义
可以使用目标作部署机群/机群空间资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
要创建 Microsoft.DocumentDB/fleets/fleetspaces 资源,请将以下 Bicep 添加到您的模板中。
resource symbolicname 'Microsoft.DocumentDB/fleets/fleetspaces@2025-05-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
fleetspaceApiKind: 'string'
provisioningState: 'string'
throughputPoolConfiguration: {
dataRegions: [
'string'
]
maxThroughput: int
minThroughput: int
serviceTier: 'string'
}
}
}
属性值
Microsoft.DocumentDB/fleets/fleetspaces
名称 | DESCRIPTION | 价值 |
---|---|---|
姓名 | 资源名称 | 字符串 约束: 最小长度 = 3 最大长度 = 50 模式 = ^[a-z0-9]+(-[a-z0-9]+)* (必需) |
家长 | 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。 有关详细信息,请参阅 父资源外部的子资源。 |
类型资源的符号名称:舰队 |
属性 | 用于更新 Azure Cosmos DB 舰队空间的属性。 | FleetspaceProperties |
FleetspaceProperties
名称 | DESCRIPTION | 价值 |
---|---|---|
fleetspaceApiKind | 此机群空间所属的 API 类型。 可接受的值:“NoSQL” | 'NoSQL' |
provisioningState | Fleetspace 的预配状态。 | “Canceled” “创建” “删除” “Failed” “初始化” “InternallyReady” “Online” “Succeeded” “未初始化” “正在更新” |
throughputPoolConfiguration | 机群空间中吞吐量池的配置。 | FleetspacePropertiesThroughputPoolConfiguration |
FleetspacePropertiesThroughputPoolConfiguration
名称 | DESCRIPTION | 价值 |
---|---|---|
数据区域 | 分配给机群空间的数据区域列表。 例如 [westus2] | 字符串[] |
maxThroughput (最大吞吐量) | 池的最大吞吐量。 | 整数 (int) |
minThroughput (最小吞吐量) | 池的最小吞吐量。 | 整数 (int) |
serviceTier 服务 | 机群空间的服务层级。 常规用途类型是指可添加到此机群空间的单个写入区域帐户,而 BusinessCritical 是指多写入区域。 | “BusinessCritical” “GeneralPurpose” |
ARM 模板资源定义
可以使用目标作部署机群/机群空间资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
要创建 Microsoft.DocumentDB/fleets/fleetspaces 资源,请将以下 JSON 添加到您的模板中。
{
"type": "Microsoft.DocumentDB/fleets/fleetspaces",
"apiVersion": "2025-05-01-preview",
"name": "string",
"properties": {
"fleetspaceApiKind": "string",
"provisioningState": "string",
"throughputPoolConfiguration": {
"dataRegions": [ "string" ],
"maxThroughput": "int",
"minThroughput": "int",
"serviceTier": "string"
}
}
}
属性值
Microsoft.DocumentDB/fleets/fleetspaces
名称 | DESCRIPTION | 价值 |
---|---|---|
apiVersion | API 版本 | “2025-05-01-预览” |
姓名 | 资源名称 | 字符串 约束: 最小长度 = 3 最大长度 = 50 模式 = ^[a-z0-9]+(-[a-z0-9]+)* (必需) |
属性 | 用于更新 Azure Cosmos DB 舰队空间的属性。 | FleetspaceProperties |
类型 | 资源类型 | 'Microsoft.DocumentDB/fleets/fleetspaces' |
FleetspaceProperties
名称 | DESCRIPTION | 价值 |
---|---|---|
fleetspaceApiKind | 此机群空间所属的 API 类型。 可接受的值:“NoSQL” | 'NoSQL' |
provisioningState | Fleetspace 的预配状态。 | “Canceled” “创建” “删除” “Failed” “初始化” “InternallyReady” “Online” “Succeeded” “未初始化” “正在更新” |
throughputPoolConfiguration | 机群空间中吞吐量池的配置。 | FleetspacePropertiesThroughputPoolConfiguration |
FleetspacePropertiesThroughputPoolConfiguration
名称 | DESCRIPTION | 价值 |
---|---|---|
数据区域 | 分配给机群空间的数据区域列表。 例如 [westus2] | 字符串[] |
maxThroughput (最大吞吐量) | 池的最大吞吐量。 | 整数 (int) |
minThroughput (最小吞吐量) | 池的最小吞吐量。 | 整数 (int) |
serviceTier 服务 | 机群空间的服务层级。 常规用途类型是指可添加到此机群空间的单个写入区域帐户,而 BusinessCritical 是指多写入区域。 | “BusinessCritical” “GeneralPurpose” |
用法示例
Terraform (AzAPI 提供程序)资源定义
可以使用目标作部署机群/机群空间资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
要创建 Microsoft.DocumentDB/fleets/fleetspaces 资源,请将以下 Terraform 添加到您的模板中。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/fleets/fleetspaces@2025-05-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
fleetspaceApiKind = "string"
provisioningState = "string"
throughputPoolConfiguration = {
dataRegions = [
"string"
]
maxThroughput = int
minThroughput = int
serviceTier = "string"
}
}
}
}
属性值
Microsoft.DocumentDB/fleets/fleetspaces
名称 | DESCRIPTION | 价值 |
---|---|---|
姓名 | 资源名称 | 字符串 约束: 最小长度 = 3 最大长度 = 50 模式 = ^[a-z0-9]+(-[a-z0-9]+)* (必需) |
parent_id | 此资源的父资源的 ID。 | 类型资源的 ID:车队 |
属性 | 用于更新 Azure Cosmos DB 舰队空间的属性。 | FleetspaceProperties |
类型 | 资源类型 | “Microsoft.DocumentDB/fleets/fleetspaces@2025-05-01-preview” |
FleetspaceProperties
名称 | DESCRIPTION | 价值 |
---|---|---|
fleetspaceApiKind | 此机群空间所属的 API 类型。 可接受的值:“NoSQL” | 'NoSQL' |
provisioningState | Fleetspace 的预配状态。 | “Canceled” “创建” “删除” “Failed” “初始化” “InternallyReady” “Online” “Succeeded” “未初始化” “正在更新” |
throughputPoolConfiguration | 机群空间中吞吐量池的配置。 | FleetspacePropertiesThroughputPoolConfiguration |
FleetspacePropertiesThroughputPoolConfiguration
名称 | DESCRIPTION | 价值 |
---|---|---|
数据区域 | 分配给机群空间的数据区域列表。 例如 [westus2] | 字符串[] |
maxThroughput (最大吞吐量) | 池的最大吞吐量。 | 整数 (int) |
minThroughput (最小吞吐量) | 池的最小吞吐量。 | 整数 (int) |
serviceTier 服务 | 机群空间的服务层级。 常规用途类型是指可添加到此机群空间的单个写入区域帐户,而 BusinessCritical 是指多写入区域。 | “BusinessCritical” “GeneralPurpose” |