Microsoft.DocumentDB 資料庫Accounts/sqlDatabases/throughputSettings
Bicep 資源定義
databaseAccounts/sqlDatabases/throughputSettings 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2024-05-15' = {
name: 'default'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
resource: {
autoscaleSettings: {
autoUpgradePolicy: {
throughputPolicy: {
incrementPercent: int
isEnabled: bool
}
}
maxThroughput: int
}
throughput: int
}
}
}
屬性值
databaseAccounts/sqlDatabases/throughputSettings
| 名稱 |
描述 |
值 |
| NAME |
資源名稱
瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
'default' |
| location |
資源所屬之資源群組的位置。 |
字串 |
| tags |
標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 |
標記名稱和值的字典。 請參閱 範本中的標籤 |
| 父系 (parent) |
在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。
如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： sqlDatabases |
| properties |
用來更新 Azure Cosmos DB 資源輸送量的屬性。 |
ThroughputSettingsUpdatePropertiesOrThroughputSettin... 必要 () |
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名稱 |
描述 |
值 |
| autoscaleSettings |
自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 |
AutoscaleSettingsResource |
| 輸送量 |
Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 |
int |
AutoscaleSettingsResource
AutoUpgradePolicyResource
ThroughputPolicyResource
| 名稱 |
描述 |
值 |
| incrementPercent |
表示每次啟動輸送量原則時，輸送量可以增加的百分比。 |
int |
| isEnabled |
判斷 ThroughputPolicy 是否為作用中 |
bool |
ARM 範本資源定義
databaseAccounts/sqlDatabases/throughputSettings 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings 資源，請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
"apiVersion": "2024-05-15",
"name": "default",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"resource": {
"autoscaleSettings": {
"autoUpgradePolicy": {
"throughputPolicy": {
"incrementPercent": "int",
"isEnabled": "bool"
}
},
"maxThroughput": "int"
},
"throughput": "int"
}
}
}
屬性值
databaseAccounts/sqlDatabases/throughputSettings
| 名稱 |
描述 |
值 |
| 類型 |
資源類型 |
'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings' |
| apiVersion |
資源 API 版本 |
'2024-05-15' |
| NAME |
資源名稱
請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。 |
'default' |
| location |
資源所屬資源群組的位置。 |
字串 |
| tags |
標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 |
標記名稱和值的字典。 請參閱 範本中的標記 |
| properties |
更新 Azure Cosmos DB 資源輸送量的屬性。 |
ThroughputSettingsUpdatePropertiesOrThroughputSettin... 必要 () |
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名稱 |
描述 |
值 |
| autoscaleSettings |
自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 |
AutoscaleSettingsResource |
| 輸送量 |
Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 |
int |
AutoscaleSettingsResource
AutoUpgradePolicyResource
ThroughputPolicyResource
| 名稱 |
描述 |
值 |
| incrementPercent |
表示每次啟動輸送量原則時，輸送量可以增加的百分比。 |
int |
| isEnabled |
判斷 ThroughputPolicy 是否為使用中 |
bool |
databaseAccounts/sqlDatabases/throughputSettings 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2024-05-15"
name = "default"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
resource = {
autoscaleSettings = {
autoUpgradePolicy = {
throughputPolicy = {
incrementPercent = int
isEnabled = bool
}
}
maxThroughput = int
}
throughput = int
}
}
})
}
屬性值
databaseAccounts/sqlDatabases/throughputSettings
| 名稱 |
描述 |
值 |
| 類型 |
資源類型 |
“Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2024-05-15” |
| NAME |
資源名稱 |
"default" |
| location |
資源所屬之資源群組的位置。 |
字串 |
| parent_id |
此資源父系之資源的標識碼。 |
類型資源的標識碼： sqlDatabases |
| tags |
標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 |
標記名稱和值的字典。 |
| properties |
用來更新 Azure Cosmos DB 資源輸送量的屬性。 |
ThroughputSettingsUpdatePropertiesOrThroughputSettin... 必要 () |
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名稱 |
描述 |
值 |
| autoscaleSettings |
自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 |
AutoscaleSettingsResource |
| 輸送量 |
Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 |
int |
AutoscaleSettingsResource
AutoUpgradePolicyResource
ThroughputPolicyResource
| 名稱 |
描述 |
值 |
| incrementPercent |
表示每次啟動輸送量原則時，輸送量可以增加的百分比。 |
int |
| isEnabled |
判斷 ThroughputPolicy 是否為使用中 |
bool |