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

Microsoft.DocumentDB databaseAccounts/cassandraKeyspaces/views/throughputSettings 2022-11-15-preview

Bicep 资源定义

可以使用面向以下操作部署 databaseAccounts/cassandraKeyspaces/views/throughputSettings 资源类型:

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

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2022-11-15-preview' = {
  name: 'default'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
}

属性值

databaseAccounts/cassandraKeyspaces/views/throughput...

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
'default'
location 资源所属的资源组的位置。 字符串
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。 请参阅 模板中的标记
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为 的资源的符号名称: 视图
标识 资源的标识。 ManagedServiceIdentity
properties 用于更新 Azure Cosmos DB 资源吞吐量的属性。 ThroughputSettingsUpdatePropertiesOrThroughputSettin... 所需的 ()

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 对象 (object)

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

名称 说明
resource 资源吞吐量的标准 JSON 格式 ThroughputSettingsResourceOrThroughputSettingsGetPro... 所需的 ()

ThroughputSettingsResourceOrThroughputSettingsGetPro...

名称 说明
autoscaleSettings 用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量,或者需要 autoscaleSettings,但不能同时满足这两项要求。 AutoscaleSettingsResource
throughput Cosmos DB 资源吞吐量的值。 需要吞吐量,或者需要 autoscaleSettings,但不能同时满足这两项要求。 int

AutoscaleSettingsResource

名称 说明
autoUpgradePolicy Cosmos DB 资源自动升级策略 AutoUpgradePolicyResource
maxThroughput 表示容器可以纵向扩展到的最大吞吐量。 int (必需)

AutoUpgradePolicyResource

名称 说明
throughputPolicy 表示服务为自动升级而必须遵守的吞吐量策略 ThroughputPolicyResource

ThroughputPolicyResource

名称 说明
incrementPercent 表示每次启动吞吐量策略时吞吐量增加的百分比。 int
isEnabled 确定 ThroughputPolicy 是否处于活动状态 bool

ARM 模板资源定义

可以使用面向以下操作部署 databaseAccounts/cassandraKeyspaces/views/throughputSettings 资源类型:

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

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings",
  "apiVersion": "2022-11-15-preview",
  "name": "default",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  }
}

属性值

databaseAccounts/cassandraKeyspaces/views/throughput...

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings'
apiVersion 资源 API 版本 “2022-11-15-preview”
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
'default'
location 资源所属的资源组的位置。 字符串
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。 请参阅 模板中的标记
标识 资源的标识。 ManagedServiceIdentity
properties 用于更新 Azure Cosmos DB 资源吞吐量的属性。 ThroughputSettingsUpdatePropertiesOrThroughputSettin... 所需的 ()

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
userAssignedIdentities 与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 对象 (object)

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

名称 说明
resource 资源吞吐量的标准 JSON 格式 ThroughputSettingsResourceOrThroughputSettingsGetPro... 所需的 ()

ThroughputSettingsResourceOrThroughputSettingsGetPro...

名称 说明
autoscaleSettings 用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量,或者需要 autoscaleSettings,但不能同时满足这两项要求。 AutoscaleSettingsResource
throughput Cosmos DB 资源吞吐量的值。 需要吞吐量,或者需要 autoscaleSettings,但不能同时满足这两项要求。 int

AutoscaleSettingsResource

名称 说明
autoUpgradePolicy Cosmos DB 资源自动升级策略 AutoUpgradePolicyResource
maxThroughput 表示容器可以纵向扩展到的最大吞吐量。 int (必需)

AutoUpgradePolicyResource

名称 说明
throughputPolicy 表示服务在自动升级时必须遵守的吞吐量策略 ThroughputPolicyResource

ThroughputPolicyResource

名称 说明
incrementPercent 表示每次启动吞吐量策略时吞吐量可以增加的百分比。 int
isEnabled 确定 ThroughputPolicy 是否处于活动状态 bool

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

databaseAccounts/cassandraKeyspaces/views/throughputSettings 资源类型可以使用以下目标操作进行部署:

  • 资源组

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

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2022-11-15-preview"
  name = "default"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

属性值

databaseAccounts/cassandraKeyspaces/views/throughput...

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/views/throughputSettings@2022-11-15-preview”
name 资源名称 "default"
location 资源所属的资源组的位置。 字符串
parent_id 此资源的父资源 ID。 类型为“视图”的资源的 ID
标记 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组(跨资源组)时,可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符,值不能超过 256 个字符。 例如,模板类型的默认体验设置为“defaultExperience”:“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 标记名称和值的字典。
标识 资源的标识。 ManagedServiceIdentity
properties 用于更新 Azure Cosmos DB 资源吞吐量的属性。 ThroughputSettingsUpdatePropertiesOrThroughputSettin... 所需的 ()

ManagedServiceIdentity

名称 说明 Value
type 用于资源的标识类型。 类型“SystemAssigned,UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。 “SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”
identity_ids 与资源关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 用户标识 ID 数组。

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

名称 说明
resource 资源吞吐量的标准 JSON 格式 ThroughputSettingsResourceOrThroughputSettingsGetPro... 所需的 ()

ThroughputSettingsResourceOrThroughputSettingsGetPro...

名称 说明
autoscaleSettings 用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量,或者需要自动缩放设置,但不能同时满足两者。 AutoscaleSettingsResource
throughput Cosmos DB 资源吞吐量的值。 需要吞吐量,或者需要自动缩放设置,但不能同时满足两者。 int

AutoscaleSettingsResource

名称 说明
autoUpgradePolicy Cosmos DB 资源自动升级策略 AutoUpgradePolicyResource
maxThroughput 表示容器可以纵向扩展的最大吞吐量。 int (必需)

AutoUpgradePolicyResource

名称 说明
throughputPolicy 表示服务在自动升级时必须遵守的吞吐量策略 ThroughputPolicyResource

ThroughputPolicyResource

名称 说明
incrementPercent 表示每次启动吞吐量策略时吞吐量可以增加的百分比。 int
isEnabled 确定 ThroughputPolicy 是否处于活动状态 bool