Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/throughputSettings

  • 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@2024-12-01-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
      throughputBuckets: [
        {
          id: int
          maxThroughputPercentage: 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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. ManagedServiceIdentity
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ść

PrzepływnośćBucketResource

Nazwa Opis Wartość
id Reprezentuje identyfikator zasobnika przepływności int (wymagane)
maxThroughputPercentage Reprezentuje maksymalną przepływność procentową, która może być używana przez zasobnik int (wymagane)

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
przepływnośćBuckets Tablica limitów zasobników przepływności, które mają być stosowane do kontenera usługi Cosmos DB PrzepływnośćBucketResource[]

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": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int",
      "throughputBuckets": [
        {
          "id": "int",
          "maxThroughputPercentage": "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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2024-12-01-preview"
tożsamość Tożsamość zasobu. ManagedServiceIdentity
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ść

PrzepływnośćBucketResource

Nazwa Opis Wartość
id Reprezentuje identyfikator zasobnika przepływności int (wymagane)
maxThroughputPercentage Reprezentuje maksymalną przepływność procentową, która może być używana przez zasobnik int (wymagane)

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
przepływnośćBuckets Tablica limitów zasobników przepływności, które mają być stosowane do kontenera usługi Cosmos DB PrzepływnośćBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

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

Przykłady użycia

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@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
        throughputBuckets = [
          {
            id = int
            maxThroughputPercentage = 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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Nazwa Opis Wartość

ManagedServiceIdentity

Nazwa Opis Wartość
typ Typ tożsamości używany dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie wszystkich tożsamości z usługi. "Brak"
"SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów arm w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Nazwa Opis Wartość

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings

Nazwa Opis Wartość
tożsamość Tożsamość zasobu. ManagedServiceIdentity
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@2024-12-01-preview"

Tagi

Nazwa Opis Wartość

PrzepływnośćBucketResource

Nazwa Opis Wartość
id Reprezentuje identyfikator zasobnika przepływności int (wymagane)
maxThroughputPercentage Reprezentuje maksymalną przepływność procentową, która może być używana przez zasobnik int (wymagane)

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
przepływnośćBuckets Tablica limitów zasobników przepływności, które mają być stosowane do kontenera usługi Cosmos DB PrzepływnośćBucketResource[]

ThroughputSettingsUpdatePropertiesOrThroughputSettingsGetProperties

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