你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DocumentDB databaseAccounts/gremlinDatabases/throughputSettings 2024-05-15-preview
- 最新
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023 年 3 月 15 日
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-06-15
- 2021-05-15
- 2021-04-15
- 2021-04-01-preview
- 2021-03-15
- 2021-03-01-preview
- 2021-01-15
- 2020-09-01
- 2020-06-01-preview
- 2020-04-01
- 2020-03-01
- 2019-12-12
- 2019-08-01
Bicep 资源定义
databaseAccounts/gremlinDatabases/throughputSettings 资源类型可以使用面向以下对象的操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2024-05-15-preview' = {
name: 'default'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
resource: {
autoscaleSettings: {
autoUpgradePolicy: {
throughputPolicy: {
incrementPercent: int
isEnabled: bool
}
}
maxThroughput: int
}
throughput: int
}
}
}
属性值
databaseAccounts/gremlinDatabases/throughputSettings
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
“default” |
| location | 资源所属的资源组的位置。 | 字符串 |
| 标记 | 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为资源的符号名称： gremlinDatabases |
| 标识 | 资源的标识。 | 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}”。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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 |
ARM 模板资源定义
databaseAccounts/gremlinDatabases/throughputSettings 资源类型可以使用面向以下对象的操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
"apiVersion": "2024-05-15-preview",
"name": "default",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"resource": {
"autoscaleSettings": {
"autoUpgradePolicy": {
"throughputPolicy": {
"incrementPercent": "int",
"isEnabled": "bool"
}
},
"maxThroughput": "int"
},
"throughput": "int"
}
}
}
属性值
databaseAccounts/gremlinDatabases/throughputSettings
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings' |
| apiVersion | 资源 API 版本 | “2024-05-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}”。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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/gremlinDatabases/throughputSettings 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2024-05-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/gremlinDatabases/throughputSettings
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2024-05-15-preview” |
| name | 资源名称 | "default" |
| location | 资源所属的资源组的位置。 | 字符串 |
| parent_id | 此资源的父资源的 ID。 | 类型为：gremlinDatabases 的资源的 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 数组。 |
ManagedServiceIdentityUserAssignedIdentities
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
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 |