Mongo DB Resources - Update Mongo DB Database Throughput

Aktualizowanie jednostek RU na sekundę bazy danych MongoDB usługi Azure Cosmos DB

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default?api-version=2021-11-15-preview

Parametry identyfikatora URI

Name In Required Type Description
accountName
path True
  • string

Nazwa konta bazy danych usługi Cosmos DB.

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

databaseName
path True
  • string

Nazwa bazy danych usługi Cosmos DB.

resourceGroupName
path True
  • string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

subscriptionId
path True
  • string

Identyfikator subskrypcji docelowej.

api-version
query True
  • string

Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Name Type Description
updateThroughputParameters

Jednostki RU na sekundę parametrów, które mają być podane dla bieżącej bazy danych MongoDB.

Odpowiedzi

Name Type Description
200 OK

Liczba jednostek RU na sekundę operacji aktualizacji bazy danych MongoDB została ukończona pomyślnie.

202 Accepted

Jednostki RU na sekundę operacji aktualizacji bazy danych MongoDB zakończą się asynchronicznie.

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

CosmosDBMongoDBDatabaseThroughputUpdate

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default?api-version=2021-11-15-preview

{
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Definicje

AutoscaleSettingsResource

Obiekt ustawień aprowizowanej przepływności usługi Cosmos DB

AutoUpgradePolicyResource

Zasady automatycznego uaktualniania zasobów usługi Cosmos DB

CloudError

Odpowiedź błędu z usługi.

ErrorResponse

Odpowiedź na błąd.

ManagedServiceIdentity

Tożsamość zasobu.

Resource
ResourceIdentityType

Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie tożsamości z usługi.

ThroughputPolicyResource

Zasady przepływności zasobów usługi Cosmos DB

ThroughputSettingsGetResults

Przepływność zasobów usługi Azure Cosmos DB.

ThroughputSettingsResource

Obiekt przepływności zasobów usługi Cosmos DB. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.

ThroughputSettingsUpdateParameters

Jednostki RU na sekundę parametrów, które mają być podane dla bieżącej bazy danych MongoDB.

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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

AutoscaleSettingsResource

Obiekt ustawień aprowizowanej przepływności usługi Cosmos DB

Name Type Description
autoUpgradePolicy

Zasady automatycznego uaktualniania zasobów usługi Cosmos DB

maxThroughput
  • integer

Reprezentuje maksymalny kontener przepływności, który może być skalowany w górę do.

targetMaxThroughput
  • integer

Reprezentuje docelowy kontener maksymalnej przepływności może skalować w górę do momentu, gdy oferta nie jest już w stanie oczekiwania.

AutoUpgradePolicyResource

Zasady automatycznego uaktualniania zasobów usługi Cosmos DB

Name Type Description
throughputPolicy

Reprezentuje zasady przepływności, które usługi muszą być zgodne z automatycznym uaktualnianiem

CloudError

Odpowiedź błędu z usługi.

Name Type Description
error

Odpowiedź na błąd.

ErrorResponse

Odpowiedź na błąd.

Name Type Description
code
  • string

Kod błędu.

message
  • string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ManagedServiceIdentity

Tożsamość zasobu.

Name Type Description
principalId
  • string

Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.

tenantId
  • string

Identyfikator dzierżawy tożsamości przypisanej przez system. Ta właściwość zostanie udostępniona tylko dla tożsamości przypisanej przez system.

type

Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie tożsamości z usługi.

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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Resource

Name Type Description
_etag
  • string

Właściwość wygenerowana przez system reprezentująca tag zasobu wymagany dla optymistycznej kontrolki współbieżności.

_rid
  • string

Właściwość wygenerowana przez system. Unikatowy identyfikator.

_ts
  • number

Właściwość wygenerowana przez system, która określa ostatnią zaktualizowaną sygnaturę czasową zasobu.

autoscaleSettings

Zasób usługi Cosmos DB dla ustawień autoskalowanie. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.

minimumThroughput
  • string

Minimalna przepływność zasobu

offerReplacePending
  • string

Oczekiwanie na zamianę przepływności

throughput
  • integer

Wartość przepływności zasobu usługi Cosmos DB. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.

ResourceIdentityType

Typ tożsamości używanej dla zasobu. Typ "SystemAssigned,UserAssigned" zawiera zarówno niejawną utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "Brak" spowoduje usunięcie tożsamości z usługi.

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ThroughputPolicyResource

Zasady przepływności zasobów usługi Cosmos DB

Name Type Description
incrementPercent
  • integer

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.

isEnabled
  • boolean

Określa, czy zasada Przepływności jest aktywna, czy nie

ThroughputSettingsGetResults

Przepływność zasobów usługi Azure Cosmos DB.

Name Type Description
id
  • string

Unikatowy identyfikator zasobu usługi ARM.

identity

Tożsamość zasobu.

location
  • string

Lokalizacja grupy zasobów, do której należy zasób.

name
  • string

Nazwa zasobu usługi ARM.

properties.resource
tags
  • object

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".

type
  • string

Typ zasobu platformy Azure.

ThroughputSettingsResource

Obiekt przepływności zasobów usługi Cosmos DB. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.

Name Type Description
autoscaleSettings

Zasób usługi Cosmos DB dla ustawień autoskalowanie. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.

minimumThroughput
  • string

Minimalna przepływność zasobu

offerReplacePending
  • string

Oczekiwanie na zamianę przepływności

throughput
  • integer

Wartość przepływności zasobu usługi Cosmos DB. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.

ThroughputSettingsUpdateParameters

Jednostki RU na sekundę parametrów, które mają być podane dla bieżącej bazy danych MongoDB.

Name Type Description
id
  • string

Unikatowy identyfikator zasobu usługi ARM.

identity

Tożsamość zasobu.

location
  • string

Lokalizacja grupy zasobów, do której należy zasób.

name
  • string

Nazwa zasobu usługi ARM.

properties.resource

Standardowy format JSON przepływności zasobu

tags
  • object

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".

type
  • string

Typ zasobu platformy Azure.

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 usługi ARM w postaci: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Name Type Description