Microsoft.DocumentDB-DatenbankAccounts/mongodbDatabases/throughputSettings 2024-05-15-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/mongodbDatabases/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/throughputSettings-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-05-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
    }
  }
}

Eigenschaftswerte

databaseAccounts/mongodbDatabases/throughputSettings

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.		 "Standard"
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
parent 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 vom Typ: mongodbDatabases
Identität Identität für die Ressource. ManagedServiceIdentity
properties Eigenschaften zum Aktualisieren des Azure Cosmos DB-Ressourcendurchsatzes. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (erforderlich)

ManagedServiceIdentity

Name BESCHREIBUNG Wert
type Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. "Keine"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name BESCHREIBUNG Wert
resource Das JSON-Standardformat eines Ressourcendurchsatzes ThroughputSettingsResourceOrThroughputSettingsGetPro... (erforderlich)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name BESCHREIBUNG Wert
autoscaleSettings Cosmos DB-Ressource für Einstellungen für die automatische Skalierung. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettingsResource
throughput Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. INT

AutoscaleSettingsResource

Name BESCHREIBUNG Wert
autoUpgradePolicy Cosmos DB-Ressourcenrichtlinie für automatisches Upgrade AutoUpgradePolicyResource
maxThroughput Stellt den maximalen Durchsatz eines Containers dar, auf den hochskaliert werden kann. int (erforderlich)

AutoUpgradePolicyResource

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

ThroughputPolicyResource

Name BESCHREIBUNG Wert
incrementPercent Stellt den Prozentsatz dar, um den der Durchsatz bei jeder Durchsatzrichtlinie erhöht werden kann. INT
isEnabled Bestimmt, ob die ThroughputPolicy aktiv ist oder nicht bool

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/mongodbDatabases/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/throughputSettings-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
  "apiVersion": "2024-05-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"
    }
  }
}

Eigenschaftswerte

databaseAccounts/mongodbDatabases/throughputSettings

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings"
apiVersion Die Ressourcen-API-Version '2024-05-15-preview'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 "Standard"
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Die Standardumgebung für einen Vorlagentyp ist beispielsweise mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Identität Identität für die Ressource. ManagedServiceIdentity
properties Eigenschaften zum Aktualisieren des Azure Cosmos DB-Ressourcendurchsatzes. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (erforderlich)

ManagedServiceIdentity

Name BESCHREIBUNG Wert
type Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. "Keine"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name BESCHREIBUNG Wert
resource Das JSON-Standardformat eines Ressourcendurchsatzes ThroughputSettingsResourceOrThroughputSettingsGetPro... (erforderlich)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name BESCHREIBUNG Wert
autoscaleSettings Cosmos DB-Ressource für Einstellungen für die autoskalierte Skalierung. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettingsResource
throughput Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. INT

AutoscaleSettingsResource

Name BESCHREIBUNG Wert
autoUpgradePolicy Richtlinie für automatisches Upgrade von Cosmos DB-Ressourcen AutoUpgradePolicyResource
maxThroughput Stellt einen Container mit maximalem Durchsatz dar, auf den hochskaliert werden kann. int (erforderlich)

AutoUpgradePolicyResource

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

ThroughputPolicyResource

Name BESCHREIBUNG Wert
incrementPercent Stellt den Prozentsatz dar, um den der Durchsatz bei jeder Einführung der Durchsatzrichtlinie erhöht werden kann. INT
isEnabled Bestimmt, ob die ThroughputPolicy aktiv ist oder nicht. bool

Terraform-Ressourcendefinition (AzAPI-Anbieter)

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

  • Ressourcengruppen

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

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-05-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
      }
    }
  })
}

Eigenschaftswerte

databaseAccounts/mongodbDatabases/throughputSettings

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings@2024-05-15-preview"
name Der Ressourcenname "default"
location Der Speicherort der Ressourcengruppe, zu der die Ressource gehört. Zeichenfolge
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: mongodbDatabases
tags Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können über Ressourcengruppen hinweg zum Anzeigen und Gruppieren von Ressourcen verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Der Schlüssel eines Tags darf nicht länger als 128 Zeichen und der Wert nicht länger als 256 Zeichen sein. Beispielsweise ist die Standardumgebung für einen Vorlagentyp auf "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB". Wörterbuch der Tagnamen und -werte.
Identität Identität für die Ressource. ManagedServiceIdentity
properties Eigenschaften zum Aktualisieren des Azure Cosmos DB-Ressourcendurchsatzes. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (erforderlich)

ManagedServiceIdentity

Name BESCHREIBUNG Wert
type Der Identitätstyp, der für die Ressource verwendet wird. Der Typ "SystemAssigned,UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten aus dem Dienst. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Bei den Referenzdaten des Benutzeridentitätswörterbuchs handelt es sich um ARM-Ressourcen-IDs in der Form : "/subscriptions/{subscriptionId}/resourceGroupGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Array von Benutzeridentitäts-IDs.

ManagedServiceIdentityUserAssignedIdentities

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name BESCHREIBUNG Wert
resource Das JSON-Standardformat eines Ressourcendurchsatzes ThroughputSettingsResourceOrThroughputSettingsGetPro... (erforderlich)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name BESCHREIBUNG Wert
autoscaleSettings Cosmos DB-Ressource für Einstellungen für die automatische Skalierung. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. AutoscaleSettingsResource
throughput Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides. INT

AutoscaleSettingsResource

Name BESCHREIBUNG Wert
autoUpgradePolicy Cosmos DB-Ressourcenrichtlinie für automatisches Upgrade AutoUpgradePolicyResource
maxThroughput Stellt den maximalen Durchsatz eines Containers dar, auf den hochskaliert werden kann. int (erforderlich)

AutoUpgradePolicyResource

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

ThroughputPolicyResource

Name BESCHREIBUNG Wert
incrementPercent Stellt den Prozentsatz dar, um den der Durchsatz bei jeder Durchsatzrichtlinie erhöht werden kann. INT
isEnabled Bestimmt, ob die ThroughputPolicy aktiv ist oder nicht bool