通过

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

Microsoft.DocumentDB throughputPools 2023-11-15-preview

  • 项目

Bicep 资源定义

throughputPools 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/throughputPools@2023-11-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    maxThroughput: int
    provisioningState: 'string'
  }
}

属性值

throughputPools

名称 说明 值
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 用于更新 Azure Cosmos DB 吞吐量池的属性。 ThroughputPoolProperties

ThroughputPoolProperties

名称 说明 值
maxThroughput 要在池中的 CosmosDB 资源之间共享的吞吐量的值。 int
provisioningState ThroughputPool 的预配状态。 “已取消”
“正在删除”
“失败”
“初始化”
“InternallyReady”
“Online”
“成功”
“未初始化”
“正在更新”

ARM 模板资源定义

throughputPools 资源类型可以使用面向以下对象的操作进行部署：

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/throughputPools",
  "apiVersion": "2023-11-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "maxThroughput": "int",
    "provisioningState": "string"
  }
}

属性值

throughputPools

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/throughputPools”
apiVersion 资源 API 版本 “2023-11-15-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 用于更新 Azure Cosmos DB 吞吐量池的属性。 ThroughputPoolProperties

ThroughputPoolProperties

名称 说明 值
maxThroughput 要在池中的 CosmosDB 资源之间共享的吞吐量的值。 int
provisioningState ThroughputPool 的预配状态。 “已取消”
“正在删除”
“失败”
“初始化”
“InternallyReady”
“Online”
“成功”
“未初始化”
“正在更新”

Terraform (AzAPI 提供程序) 资源定义

throughputPools 资源类型可以使用面向以下对象的操作进行部署：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/throughputPools@2023-11-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      maxThroughput = int
      provisioningState = "string"
    }
  })
}

属性值

throughputPools

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/throughputPools@2023-11-15-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置 字符串 (必需)
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
properties 用于更新 Azure Cosmos DB 吞吐量池的属性。 ThroughputPoolProperties

ThroughputPoolProperties

名称 说明 值
maxThroughput 要在池中的 CosmosDB 资源之间共享的吞吐量的值。 int
provisioningState ThroughputPool 的预配状态。 “已取消”
“正在删除”
“Failed”
“初始化”
“InternallyReady”
“Online”
“Succeeded”
“未初始化”
“正在更新”