Udostępnij za pośrednictwem

Microsoft.DocumentDB databaseAccounts/gremlinDatabases/throughputSettings 2021-05-15

  • Artykuł

Definicja zasobu Bicep

Typ zasobu databaseAccounts/gremlinDatabases/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 dziennik zmian.

Format zasobu

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-05-15' = {
  name: 'default'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    resource: {
      autoscaleSettings: {
        autoUpgradePolicy: {
          throughputPolicy: {
            incrementPercent: int
            isEnabled: bool
          }
        }
        maxThroughput: int
      }
      throughput: int
    }
  }
}

Wartości właściwości

databaseAccounts/gremlinDatabases/throughputSettings

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 "default"
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą być używane w wyświetlaniu i grupowaniu tego zasobu (w grupach zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
Nadrzędny W pliku 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: gremlinDatabases
properties Właściwości do aktualizowania przepływności zasobów usługi Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (wymagane)

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

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

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nazwa Opis Wartość
autoskalowanieUstawienia Zasób usługi Cosmos DB dla ustawień autoskalowanie. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba. AutoskalowanieSettingsResource
danych Wartość przepływności zasobu usługi Cosmos DB. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba. int

AutoskalowanieSettingsResource

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

AutoUpgradePolicyResource

Nazwa Opis Wartość
throughputPolicy Reprezentuje zasady przepływności, które usługa musi być zgodna z zasadami automatycznego uaktualniania PrzepływnośćZasadyResource

PrzepływnośćZasadyResource

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 element ThroughputPolicy jest aktywny, czy nie bool

Definicja zasobu szablonu usługi ARM

Typ zasobu databaseAccounts/gremlinDatabases/throughputSettings można wdrożyć z operacjami docelowymi:

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

Format zasobu

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings",
  "apiVersion": "2021-05-15",
  "name": "default",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "resource": {
      "autoscaleSettings": {
        "autoUpgradePolicy": {
          "throughputPolicy": {
            "incrementPercent": "int",
            "isEnabled": "bool"
          }
        },
        "maxThroughput": "int"
      },
      "throughput": "int"
    }
  }
}

Wartości właściwości

databaseAccounts/gremlinDatabases/throughputSettings

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings"
apiVersion Wersja interfejsu API zasobów '2021-05-15'
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.		 "default"
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości. Zobacz Tagi w szablonach
properties Właściwości do aktualizowania przepływności zasobów usługi Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (wymagane)

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nazwa Opis Wartość
zasób Standardowy format JSON przepływności zasobów ThroughputSettingsResourceOrThroughputSettingsGetPro... (wymagane)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nazwa Opis Wartość
autoskalowanieUstawienia Zasób usługi Cosmos DB dla ustawień skalowania automatycznego. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba. AutoskalowanieUstawieniaResource
danych Wartość przepływności zasobów usługi Cosmos DB. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba. int

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żna skalować w górę. int (wymagane)

AutoUpgradePolicyResource

Nazwa Opis Wartość
throughputPolicy Reprezentuje zasady przepływności, które usługa musi być zgodna z zasadami automatycznego uaktualniania PrzepływnośćZasadyResource

PrzepływnośćZasadyResource

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 element ThroughputPolicy jest aktywny, czy nie bool

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu databaseAccounts/gremlinDatabases/throughputSettings można wdrożyć z operacjami docelowymi:

  • Grupy zasobów

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

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-05-15"
  name = "default"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      resource = {
        autoscaleSettings = {
          autoUpgradePolicy = {
            throughputPolicy = {
              incrementPercent = int
              isEnabled = bool
            }
          }
          maxThroughput = int
        }
        throughput = int
      }
    }
  })
}

Wartości właściwości

databaseAccounts/gremlinDatabases/throughputSettings

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings@2021-05-15"
name Nazwa zasobu "default"
location Lokalizacja grupy zasobów, do której należy zasób. ciąg
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: gremlinDatabases
tags Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". Słownik nazw tagów i wartości.
properties Właściwości do aktualizowania przepływności zasobów usługi Azure Cosmos DB. ThroughputSettingsUpdatePropertiesOrThroughputSettin... (wymagane)

ThroughputSettingsUpdatePropertiesOrThroughputSettin...

Nazwa Opis Wartość
zasób Standardowy format JSON przepływności zasobów ThroughputSettingsResourceOrThroughputSettingsGetPro... (wymagane)

ThroughputSettingsResourceOrThroughputSettingsGetPro...

Nazwa Opis Wartość
autoskalowanieUstawienia Zasób usługi Cosmos DB dla ustawień skalowania automatycznego. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba. AutoskalowanieUstawieniaResource
danych Wartość przepływności zasobów usługi Cosmos DB. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba. int

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żna skalować w górę. int (wymagane)

AutoUpgradePolicyResource

Nazwa Opis Wartość
throughputPolicy Reprezentuje zasady przepływności, które usługa musi być zgodna z zasadami automatycznego uaktualniania PrzepływnośćZasadyResource

PrzepływnośćZasadyResource

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 element ThroughputPolicy jest aktywny, czy nie bool