Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections/throughputSettings 2024-05-15-preview

  • Artikel

Bicep-resursdefinition

Resurstypen databaseAccounts/mongodbDatabases/collections/throughputSettings kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/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
    }
  }
}

Egenskapsvärden

databaseAccounts/mongodbDatabases/collections/throug...

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 "standard"
location Platsen för resursgruppen som resursen tillhör. sträng
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden. Se Taggar i mallar
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: samlingar
identity Identitet för resursen. ManagedServiceIdentity
properties Egenskaper för att uppdatera resursdataflödet i Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (krävs)

ManagedServiceIdentity

Name Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. "Ingen"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"Användartilldelade"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Beskrivning Värde
{anpassad egenskap} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Beskrivning Värde
resource JSON-standardformatet för ett resursdataflöde ThroughputSettingsResourceOrThroughputSettingsGetPro... (krävs)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Beskrivning Värde
autoscaleSettings Cosmos DB-resurs för autoskalningsinställningar. Antingen krävs dataflöde eller autoscaleSettings, men inte båda. AutoscaleSettingsResource
dataflöde Värdet för Cosmos DB-resursens dataflöde. Antingen krävs dataflöde eller autoscaleSettings, men inte båda. int

AutoscaleSettingsResource

Name Beskrivning Värde
autoUpgradePolicy Princip för automatisk uppgradering av Cosmos DB-resurser AutoUpgradePolicyResource
maxThroughput Representerar maximal dataflödescontainer som kan skalas upp till. int (krävs)

AutoUpgradePolicyResource

Name Beskrivning Värde
throughputPolicy Representerar en dataflödesprincip som tjänsten måste följa för automatisk uppgradering ThroughputPolicyResource

ThroughputPolicyResource

Name Beskrivning Värde
incrementPercent Representerar den procentandel med vilken dataflödet kan öka varje gång dataflödesprincipen startar. int
isEnabled Avgör om Dataflödepolicyn är aktiv eller inte boolesk

Resursdefinition för ARM-mall

Resurstypen databaseAccounts/mongodbDatabases/collections/throughputSettings kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/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"
    }
  }
}

Egenskapsvärden

databaseAccounts/mongodbDatabases/collections/throug...

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings"
apiVersion Resurs-API-versionen "2024-05-15-preview"
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 "standard"
location Platsen för den resursgrupp som resursen tillhör. sträng
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden. Se Taggar i mallar
identity Identitet för resursen. ManagedServiceIdentity
properties Egenskaper för att uppdatera dataflödet för Azure Cosmos DB-resurser. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (krävs)

ManagedServiceIdentity

Name Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort eventuella identiteter från tjänsten. "Ingen"
"SystemTilldelade"
"SystemAssigned,UserAssigned"
"Användartilldelade"
userAssignedIdentities Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentiteter

ManagedServiceIdentityUserAssignedIdentiteter

Name Beskrivning Värde
{anpassad egenskap} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Beskrivning Värde
resource JSON-standardformatet för ett resursdataflöde ThroughputSettingsResourceOrThroughputSettingsGetPro... (krävs)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Beskrivning Värde
autoscaleSettings Cosmos DB-resurs för autoskalningsinställningar. Antingen krävs dataflöde eller autoscaleSettings, men inte båda. AutoscaleSettingsResource
dataflöde Värdet för Cosmos DB-resursens dataflöde. Antingen krävs dataflöde eller autoscaleSettings, men inte båda. int

AutoscaleSettingsResource

Name Beskrivning Värde
autoUpgradePolicy Princip för automatisk uppgradering av Cosmos DB-resurser AutoUpgradePolicyResource
maxThroughput Representerar maximal dataflödescontainer som kan skalas upp till. int (krävs)

AutoUpgradePolicyResource

Name Beskrivning Värde
throughputPolicy Representerar en dataflödesprincip som tjänsten måste följa för automatisk uppgradering ThroughputPolicyResource

ThroughputPolicyResource

Name Beskrivning Värde
incrementPercent Representerar den procentandel med vilken dataflödet kan öka varje gång dataflödesprincipen startar. int
isEnabled Avgör om Dataflödepolicyn är aktiv eller inte boolesk

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen databaseAccounts/mongodbDatabases/collections/throughputSettings kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

databaseAccounts/mongodbDatabases/collections/throug...

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections/throughputSettings@2024-05-15-preview"
name Resursnamnet "standard"
location Platsen för den resursgrupp som resursen tillhör. sträng
parent_id ID:t för resursen som är överordnad för den här resursen. ID för resurs av typen: samlingar
tags Taggar är en lista över nyckel/värde-par som beskriver resursen. De här taggarna kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB". Ordlista med taggnamn och värden.
identity Identitet för resursen. ManagedServiceIdentity
properties Egenskaper för att uppdatera dataflödet för Azure Cosmos DB-resurser. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (krävs)

ManagedServiceIdentity

Name Beskrivning Värde
typ Den typ av identitet som används för resursen. Typen "SystemAssigned,UserAssigned" innehåller både en implicit skapad identitet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matris med användaridentitets-ID:t.

ManagedServiceIdentityUserAssignedIdentities

Name Beskrivning Värde
{anpassad egenskap} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Det här objektet innehåller inga egenskaper som ska anges under distributionen. Alla egenskaper är ReadOnly.

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Name Beskrivning Värde
resource JSON-standardformatet för ett resursdataflöde ThroughputSettingsResourceOrThroughputSettingsGetPro... (krävs)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Name Beskrivning Värde
autoscaleSettings Cosmos DB-resurs för autoskalningsinställningar. Antingen krävs dataflöde eller så krävs autoscaleSettings, men inte båda. AutoscaleSettingsResource
dataflöde Värdet för Cosmos DB-resursens dataflöde. Antingen krävs dataflöde eller så krävs autoscaleSettings, men inte båda. int

AutoscaleSettingsResource

Name Beskrivning Värde
autoUpgradePolicy Princip för automatisk uppgradering av Cosmos DB-resurser AutoUpgradePolicyResource
maxThroughput Representerar maximalt dataflöde som containern kan skala upp till. int (obligatoriskt)

AutoUpgradePolicyResource

Name Beskrivning Värde
throughputPolicy Representerar den dataflödesprincip som tjänsten måste följa för automatisk uppgradering ThroughputPolicyResource

ThroughputPolicyResource

Name Beskrivning Värde
incrementPercent Representerar den procentandel med vilken dataflödet kan öka varje gång dataflödesprincipen startar. int
isEnabled Avgör om ThroughputPolicy är aktiv eller inte boolesk