共用方式為

Microsoft.DocumentDB 資料庫Accounts/mongodbDatabases/collections/throughputSettings 2024-05-15-preview

  • 發行項

Bicep 資源定義

databaseAccounts/mongodbDatabases/collections/throughputSettings 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2024-05-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'default'
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

AutoscaleSettingsResource

名字 描述 價值
autoUpgradePolicy Cosmos DB 資源自動升級原則 AutoUpgradePolicyResource
maxThroughput 表示最大輸送量容器可以相應增加至此數目。 int （必要）

AutoUpgradePolicyResource

名字 描述 價值
throughputPolicy 表示服務必須遵守以進行自動升級的輸送量原則 ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字 描述 價值

ManagedServiceIdentity

名字 描述 價值
類型 用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
'UserAssigned'
userAssignedIdentities 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 價值

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

名字 描述 價值
身份 資源的身分識別。 ManagedServiceIdentity
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 'default' （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱：databaseAccounts/mongodbDatabases/collections
性能 更新 Azure Cosmos DB 資源輸送量的屬性。 ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

標籤

名字 描述 價值

ThroughputPolicyResource

名字 描述 價值
incrementPercent 表示每次輸送量原則啟動時，輸送量可以增加的百分比。 int
isEnabled 判斷 ThroughputPolicy 是否為使用中 bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名字 描述 價值
autoscaleSettings 自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 AutoscaleSettingsResource
輸送量 Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名字 描述 價值
資源 資源輸送量的標準 JSON 格式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource （必要）

ARM 樣本資源定義

databaseAccounts/mongodbDatabases/collections/throughputSettings 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings",
  "apiVersion": "2024-05-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

AutoscaleSettingsResource

名字 描述 價值
autoUpgradePolicy Cosmos DB 資源自動升級原則 AutoUpgradePolicyResource
maxThroughput 表示最大輸送量容器可以相應增加至此數目。 int （必要）

AutoUpgradePolicyResource

名字 描述 價值
throughputPolicy 表示服務必須遵守以進行自動升級的輸送量原則 ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字 描述 價值

ManagedServiceIdentity

名字 描述 價值
類型 用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
'UserAssigned'
userAssignedIdentities 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 價值

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

名字 描述 價值
apiVersion API 版本 '2024-05-15-preview'
身份 資源的身分識別。 ManagedServiceIdentity
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 'default' （必要）
性能 更新 Azure Cosmos DB 資源輸送量的屬性。 ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings'

標籤

名字 描述 價值

ThroughputPolicyResource

名字 描述 價值
incrementPercent 表示每次輸送量原則啟動時，輸送量可以增加的百分比。 int
isEnabled 判斷 ThroughputPolicy 是否為使用中 bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名字 描述 價值
autoscaleSettings 自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 AutoscaleSettingsResource
輸送量 Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名字 描述 價值
資源 資源輸送量的標準 JSON 格式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource （必要）

Terraform （AzAPI 提供者） 資源定義

databaseAccounts/mongodbDatabases/collections/throughputSettings 資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2024-05-15-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

屬性值

AutoscaleSettingsResource

名字 描述 價值
autoUpgradePolicy Cosmos DB 資源自動升級原則 AutoUpgradePolicyResource
maxThroughput 表示最大輸送量容器可以相應增加至此數目。 int （必要）

AutoUpgradePolicyResource

名字 描述 價值
throughputPolicy 表示服務必須遵守以進行自動升級的輸送量原則 ThroughputPolicyResource

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字 描述 價值

ManagedServiceIdentity

名字 描述 價值
類型 用於資源的身分識別類型。 類型 'SystemAssigned，UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從服務中移除任何身分識別。 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
'UserAssigned'
userAssignedIdentities 與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名字 描述 價值

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

名字 描述 價值
身份 資源的身分識別。 ManagedServiceIdentity
位置 資源所屬資源群組的位置。 字串
名字 資源名稱 'default' （必要）
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼：databaseAccounts/mongodbDatabases/collections
性能 更新 Azure Cosmos DB 資源輸送量的屬性。 ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties （必要）
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2024-05-15-preview”

標籤

名字 描述 價值

ThroughputPolicyResource

名字 描述 價值
incrementPercent 表示每次輸送量原則啟動時，輸送量可以增加的百分比。 int
isEnabled 判斷 ThroughputPolicy 是否為使用中 bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

名字 描述 價值
autoscaleSettings 自動調整設定的 Cosmos DB 資源。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 AutoscaleSettingsResource
輸送量 Cosmos DB 資源輸送量的值。 需要輸送量或需要 autoscaleSettings，但不需要兩者。 int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

名字 描述 價值
資源 資源輸送量的標準 JSON 格式 ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource （必要）