Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/throughputSettings 2023-09-15

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/mongodbDatabases/throughputSettings można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

AutoskalowanieUstawieniaResource

Nazwa Opis Wartość
autoUpgradePolicy Zasady automatycznego uaktualniania zasobów usługi Cosmos DB AutoUpgradePolicyResource
maxThroughput Reprezentuje maksymalny kontener przepływności, który może być skalowany w górę. int (wymagane)

AutoUpgradePolicyResource

Nazwa Opis Wartość
przepływnośćZasady Reprezentuje zasady przepływności, które muszą być zgodne z usługą w celu automatycznego uaktualniania ThroughputPolicyResource

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nazwa Opis Wartość
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu "default" (wymagane)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: databaseAccounts/mongodbDatabases
Właściwości Właściwości do aktualizowania przepływności zasobów usługi Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Tagi

Nazwa Opis Wartość

ThroughputPolicyResource

Nazwa Opis Wartość
incrementPercent Reprezentuje wartość procentową, za pomocą której przepływność może zwiększać się za każdym razem, gdy zasady przepływności są uruchamiane. Int
isEnabled Określa, czy funkcja ThroughputPolicy jest aktywna, czy nie Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nazwa Opis Wartość
autoskalowanieUstawienia Zasób usługi Cosmos DB dla ustawień skalowania automatycznego. Wymagana jest przepływność lub funkcja autoskalowaniaUstawienia jest wymagana, ale nie obie. AutoskalowanieUstawieniaResource
przepustowość Wartość przepływności zasobów usługi Cosmos DB. Wymagana jest przepływność lub funkcja autoskalowaniaUstawienia jest wymagana, ale nie obie. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nazwa Opis Wartość
zasób Standardowy format JSON przepływności zasobu ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (wymagane)

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/mongodbDatabases/throughputSettings można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

AutoskalowanieUstawieniaResource

Nazwa Opis Wartość
autoUpgradePolicy Zasady automatycznego uaktualniania zasobów usługi Cosmos DB AutoUpgradePolicyResource
maxThroughput Reprezentuje maksymalny kontener przepływności, który może być skalowany w górę. int (wymagane)

AutoUpgradePolicyResource

Nazwa Opis Wartość
przepływnośćZasady Reprezentuje zasady przepływności, które muszą być zgodne z usługą w celu automatycznego uaktualniania ThroughputPolicyResource

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2023-09-15'
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu "default" (wymagane)
Właściwości Właściwości do aktualizowania przepływności zasobów usługi Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings"

Tagi

Nazwa Opis Wartość

ThroughputPolicyResource

Nazwa Opis Wartość
incrementPercent Reprezentuje wartość procentową, za pomocą której przepływność może zwiększać się za każdym razem, gdy zasady przepływności są uruchamiane. Int
isEnabled Określa, czy funkcja ThroughputPolicy jest aktywna, czy nie Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nazwa Opis Wartość
autoskalowanieUstawienia Zasób usługi Cosmos DB dla ustawień skalowania automatycznego. Wymagana jest przepływność lub funkcja autoskalowaniaUstawienia jest wymagana, ale nie obie. AutoskalowanieUstawieniaResource
przepustowość Wartość przepływności zasobów usługi Cosmos DB. Wymagana jest przepływność lub funkcja autoskalowaniaUstawienia jest wymagana, ale nie obie. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nazwa Opis Wartość
zasób Standardowy format JSON przepływności zasobu ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (wymagane)

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/mongodbDatabases/throughputSettings można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

AutoskalowanieUstawieniaResource

Nazwa Opis Wartość
autoUpgradePolicy Zasady automatycznego uaktualniania zasobów usługi Cosmos DB AutoUpgradePolicyResource
maxThroughput Reprezentuje maksymalny kontener przepływności, który może być skalowany w górę. int (wymagane)

AutoUpgradePolicyResource

Nazwa Opis Wartość
przepływnośćZasady Reprezentuje zasady przepływności, które muszą być zgodne z usługą w celu automatycznego uaktualniania ThroughputPolicyResource

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nazwa Opis Wartość
lokalizacja Lokalizacja grupy zasobów, do której należy zasób. struna
nazwa Nazwa zasobu "default" (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: databaseAccounts/mongodbDatabases
Właściwości Właściwości do aktualizowania przepływności zasobów usługi Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (wymagane)
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2023-09-15"

Tagi

Nazwa Opis Wartość

ThroughputPolicyResource

Nazwa Opis Wartość
incrementPercent Reprezentuje wartość procentową, za pomocą której przepływność może zwiększać się za każdym razem, gdy zasady przepływności są uruchamiane. Int
isEnabled Określa, czy funkcja ThroughputPolicy jest aktywna, czy nie Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Nazwa Opis Wartość
autoskalowanieUstawienia Zasób usługi Cosmos DB dla ustawień skalowania automatycznego. Wymagana jest przepływność lub funkcja autoskalowaniaUstawienia jest wymagana, ale nie obie. AutoskalowanieUstawieniaResource
przepustowość Wartość przepływności zasobów usługi Cosmos DB. Wymagana jest przepływność lub funkcja autoskalowaniaUstawienia jest wymagana, ale nie obie. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Nazwa Opis Wartość
zasób Standardowy format JSON przepływności zasobu ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (wymagane)