Freigeben über

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections/throughputSettings 2023-04-15

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/mongodbDatabases/collections/throughputSettings kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

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

Eigenschaftswerte

AutoscaleSettingsResource

Name Beschreibung Wert
autoUpgradePolicy Cosmos DB-Ressourcenrichtlinie für automatische Upgrades AutoUpgradePolicyResource-
maxThroughput Stellt den maximalen Durchsatzcontainer dar, der bis zu skalieren kann. int (erforderlich)

AutoUpgradePolicyResource

Name Beschreibung Wert
throughputPolicy Stellt die Durchsatzrichtlinie dar, der der Dienst für das automatische Upgrade einhalten muss. ThroughputPolicyResource-

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Name Beschreibung Wert
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname "default" (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource des Typs: databaseAccounts/mongodbDatabases/collections
Eigenschaften Eigenschaften zum Aktualisieren des Azure Cosmos DB-Ressourcendurchsatzes. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

Schilder

Name Beschreibung Wert

ThroughputPolicyResource

Name Beschreibung Wert
incrementPercent Stellt den Prozentsatz dar, um den der Durchsatz bei jedem Start der Durchsatzrichtlinie erhöht werden kann. Int
isEnabled Bestimmt, ob die Durchsatzpolicy aktiv ist oder nicht. Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Name Beschreibung Wert
autoscaleSettings Cosmos DB-Ressource für Autoskaleneinstellungen. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettingsResource-
Durchsatz Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Name Beschreibung Wert
Ressource Das standardmäßige JSON-Format eines Ressourcendurchsatzes ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (erforderlich)

ARM-Vorlagenressourcendefinition

Der Ressourcentyp databaseAccounts/mongodbDatabases/collections/throughputSettings kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

AutoscaleSettingsResource

Name Beschreibung Wert
autoUpgradePolicy Cosmos DB-Ressourcenrichtlinie für automatische Upgrades AutoUpgradePolicyResource-
maxThroughput Stellt den maximalen Durchsatzcontainer dar, der bis zu skalieren kann. int (erforderlich)

AutoUpgradePolicyResource

Name Beschreibung Wert
throughputPolicy Stellt die Durchsatzrichtlinie dar, der der Dienst für das automatische Upgrade einhalten muss. ThroughputPolicyResource-

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Name Beschreibung Wert
apiVersion Die API-Version '2023-04-15'
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname "default" (erforderlich)
Eigenschaften Eigenschaften zum Aktualisieren des Azure Cosmos DB-Ressourcendurchsatzes. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings'

Schilder

Name Beschreibung Wert

ThroughputPolicyResource

Name Beschreibung Wert
incrementPercent Stellt den Prozentsatz dar, um den der Durchsatz bei jedem Start der Durchsatzrichtlinie erhöht werden kann. Int
isEnabled Bestimmt, ob die Durchsatzpolicy aktiv ist oder nicht. Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Name Beschreibung Wert
autoscaleSettings Cosmos DB-Ressource für Autoskaleneinstellungen. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettingsResource-
Durchsatz Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Name Beschreibung Wert
Ressource Das standardmäßige JSON-Format eines Ressourcendurchsatzes ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (erforderlich)

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp databaseAccounts/mongodbDatabases/collections/throughputSettings kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

AutoscaleSettingsResource

Name Beschreibung Wert
autoUpgradePolicy Cosmos DB-Ressourcenrichtlinie für automatische Upgrades AutoUpgradePolicyResource-
maxThroughput Stellt den maximalen Durchsatzcontainer dar, der bis zu skalieren kann. int (erforderlich)

AutoUpgradePolicyResource

Name Beschreibung Wert
throughputPolicy Stellt die Durchsatzrichtlinie dar, der der Dienst für das automatische Upgrade einhalten muss. ThroughputPolicyResource-

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings

Name Beschreibung Wert
Ort Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Schnur
Name Der Ressourcenname "default" (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: databaseAccounts/mongodbDatabases/collections
Eigenschaften Eigenschaften zum Aktualisieren des Azure Cosmos DB-Ressourcendurchsatzes. ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties (erforderlich)
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2023-04-15"

Schilder

Name Beschreibung Wert

ThroughputPolicyResource

Name Beschreibung Wert
incrementPercent Stellt den Prozentsatz dar, um den der Durchsatz bei jedem Start der Durchsatzrichtlinie erhöht werden kann. Int
isEnabled Bestimmt, ob die Durchsatzpolicy aktiv ist oder nicht. Bool

ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource

Name Beschreibung Wert
autoscaleSettings Cosmos DB-Ressource für Autoskaleneinstellungen. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettingsResource-
Durchsatz Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. Int

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

Name Beschreibung Wert
Ressource Das standardmäßige JSON-Format eines Ressourcendurchsatzes ThroughputSettingsResourceOrThroughputSettingsGetPropertiesResource (erforderlich)