通过

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

Microsoft.DocumentDB throughputPools 2024-09-01-preview

  • 项目

Bicep 资源定义

可以使用目标操作部署 throughputPools 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/throughputPools@2024-09-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    maxThroughput: int
    provisioningState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.DocumentDB/throughputPools

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需）
性能 用于更新 Azure Cosmos DB 吞吐量池的属性。 ThroughputPoolProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ThroughputPoolProperties

名字 描述 价值
maxThroughput 要在池中的 CosmosDB 资源之间共享的吞吐量的值。 int
provisioningState ThroughputPool 的预配状态。 “Canceled”
“删除”
“Failed”
“初始化”
“InternallyReady”
“Online”
“Succeeded”
“未初始化”
“正在更新”

TrackedResourceTags

名字 描述 价值

ARM 模板资源定义

可以使用目标操作部署 throughputPools 资源类型：

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/throughputPools",
  "apiVersion": "2024-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "maxThroughput": "int",
    "provisioningState": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.DocumentDB/throughputPools

名字 描述 价值
apiVersion API 版本 '2024-09-01-preview'
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需）
性能 用于更新 Azure Cosmos DB 吞吐量池的属性。 ThroughputPoolProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.DocumentDB/throughputPools”

ThroughputPoolProperties

名字 描述 价值
maxThroughput 要在池中的 CosmosDB 资源之间共享的吞吐量的值。 int
provisioningState ThroughputPool 的预配状态。 “Canceled”
“删除”
“Failed”
“初始化”
“InternallyReady”
“Online”
“Succeeded”
“未初始化”
“正在更新”

TrackedResourceTags

名字 描述 价值

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

可以使用目标操作部署 throughputPools 资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/throughputPools@2024-09-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      maxThroughput = int
      provisioningState = "string"
    }
  })
}

属性值

Microsoft.DocumentDB/throughputPools

名字 描述 价值
位置 资源所在的地理位置 string （必需）
名字 资源名称 字符串

约束：
最小长度 = 3
最大长度 = 3
模式 = ^[a-z0-9]+(-[a-z0-9]+)* （必需）
性能 用于更新 Azure Cosmos DB 吞吐量池的属性。 ThroughputPoolProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.DocumentDB/throughputPools@2024-09-01-preview”

ThroughputPoolProperties

名字 描述 价值
maxThroughput 要在池中的 CosmosDB 资源之间共享的吞吐量的值。 int
provisioningState ThroughputPool 的预配状态。 “Canceled”
“删除”
“Failed”
“初始化”
“InternallyReady”
“Online”
“Succeeded”
“未初始化”
“正在更新”

TrackedResourceTags

名字 描述 价值