Microsoft.DocumentDB 資料庫Accounts/sqlDatabases/throughputSettings 2023-03-15-preview
- 最新
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-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-預覽版
- 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/sqlDatabases/throughputSettings 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2023-03-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/sqlDatabases/throughputSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
'default' |
| location | 資源所屬資源群組的位置。 | 字串 |
| tags | 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| 父系 (parent) | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型的資源符號名稱： sqlDatabases |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 更新 Azure Cosmos DB 資源輸送量的屬性。 | ThroughputSettingsUpdatePropertiesOrThroughputSettin... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned'：用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 同時包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 |
|
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
| 名稱 | 描述 | 值 |
|---|---|---|
| 資源 | 資源輸送量的標準 JSON 格式 | ThroughputSettingsResourceOrThroughputSettingsGetPro... 必要 () |
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 | AutoscaleSettingsResource |
| 輸送量 | Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 | int |
AutoscaleSettingsResource
| 名稱 | 描述 | 值 |
|---|---|---|
| autoUpgradePolicy | Cosmos DB 資源自動升級原則 | AutoUpgradePolicyResource |
| maxThroughput | 表示輸送量容器可以相應增加至的上限。 | 需要 int () |
AutoUpgradePolicyResource
| 名稱 | 描述 | 值 |
|---|---|---|
| throughputPolicy | 表示服務必須遵守以進行自動升級的輸送量原則 | ThroughputPolicyResource |
ThroughputPolicyResource
| 名稱 | 描述 | 值 |
|---|---|---|
| incrementPercent | 表示每次啟動輸送量原則時，輸送量可以增加的百分比。 | int |
| isEnabled | 判斷 ThroughputPolicy 是否為使用中 | bool |
ARM 範本資源定義
databaseAccounts/sqlDatabases/throughputSettings 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings",
"apiVersion": "2023-03-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/sqlDatabases/throughputSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings' |
| apiVersion | 資源 API 版本 | '2023-03-15-preview' |
| NAME | 資源名稱 瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。 |
'default' |
| location | 資源所屬之資源群組的位置。 | 字串 |
| tags | 標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 請參閱 範本中的標籤 |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 用來更新 Azure Cosmos DB 資源輸送量的屬性。 | ThroughputSettingsUpdatePropertiesOrThroughputSettin... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 'None' 'SystemAssigned' 'SystemAssigned，UserAssigned' 'UserAssigned'：用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 同時包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 |
|
| userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
| 名稱 | 描述 | 值 |
|---|---|---|
| 資源 | 資源輸送量的標準 JSON 格式 | ThroughputSettingsResourceOrThroughputSettingsGetPro... 必要 () |
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 | AutoscaleSettingsResource |
| 輸送量 | Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 | int |
AutoscaleSettingsResource
| 名稱 | 描述 | 值 |
|---|---|---|
| autoUpgradePolicy | Cosmos DB 資源自動升級原則 | AutoUpgradePolicyResource |
| maxThroughput | 表示可以相應增加的輸送量容器上限。 | int (必要) |
AutoUpgradePolicyResource
| 名稱 | 描述 | 值 |
|---|---|---|
| throughputPolicy | 表示服務必須遵守以進行自動升級的輸送量原則 | ThroughputPolicyResource |
ThroughputPolicyResource
| 名稱 | 描述 | 值 |
|---|---|---|
| incrementPercent | 表示每次啟動輸送量原則時，輸送量可以增加的百分比。 | int |
| isEnabled | 判斷 ThroughputPolicy 是否為作用中 | bool |
Terraform (AzAPI 提供者) 資源定義
databaseAccounts/sqlDatabases/throughputSettings 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2023-03-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/sqlDatabases/throughputSettings
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings@2023-03-15-preview” |
| NAME | 資源名稱 | "default" |
| location | 資源所屬資源群組的位置。 | 字串 |
| parent_id | 此資源之父系的資源標識碼。 | 類型的資源標識碼： sqlDatabases |
| tags | 標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 | 標記名稱和值的字典。 |
| 身分識別 | 資源的身分識別。 | ManagedServiceIdentity |
| properties | 更新 Azure Cosmos DB 資源輸送量的屬性。 | ThroughputSettingsUpdatePropertiesOrThroughputSettin... 必要 () |
ManagedServiceIdentity
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”：用於資源的身分識別類型。 類型 「SystemAssigned，UserAssigned」 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 「None」 會從服務中移除任何身分識別。 |
|
| identity_ids | 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 | 使用者身分識別標識碼的陣列。 |
ManagedServiceIdentityUserAssignedIdentities
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | Components1Jq1T4ISchemasManagedserviceidentityProper... |
Components1Jq1T4ISchemasManagedserviceidentityProper...
此物件不包含部署期間要設定的任何屬性。 所有屬性都是 ReadOnly。
ThroughputSettingsUpdatePropertiesOrThroughputSettin...
| 名稱 | 描述 | 值 |
|---|---|---|
| 資源 | 資源輸送量的標準 JSON 格式 | ThroughputSettingsResourceOrThroughputSettingsGetPro... 必要 () |
ThroughputSettingsResourceOrThroughputSettingsGetPro...
| 名稱 | 描述 | 值 |
|---|---|---|
| autoscaleSettings | 自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 | AutoscaleSettingsResource |
| 輸送量 | Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 | int |
AutoscaleSettingsResource
| 名稱 | 描述 | 值 |
|---|---|---|
| autoUpgradePolicy | Cosmos DB 資源自動升級原則 | AutoUpgradePolicyResource |
| maxThroughput | 表示輸送量容器可以相應增加至的上限。 | 需要 int () |
AutoUpgradePolicyResource
| 名稱 | 描述 | 值 |
|---|---|---|
| throughputPolicy | 表示服務必須遵守以進行自動升級的輸送量原則 | ThroughputPolicyResource |
ThroughputPolicyResource
| 名稱 | 描述 | 值 |
|---|---|---|
| incrementPercent | 表示每次啟動輸送量原則時，輸送量可以增加的百分比。 | int |
| isEnabled | 判斷 ThroughputPolicy 是否為使用中 | bool |
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應