Mongo DB Resources - Update Mongo DB Database Throughput

Odwołanie

Service:: Cosmos DB Resource Provider

API Version:: 2023-11-15

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=2023-11-15

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
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

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

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ThroughputSettingsGetResults	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 zostaną ukończone asynchronicznie. Headers azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

ThroughputSettingsGetResults

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 zostaną ukończone asynchronicznie.

Headers

azure-AsyncOperation: string
location: string

Other Status Codes

CloudError

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

Nazwa	Opis
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=2023-11-15

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


import com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource;
import com.azure.resourcemanager.cosmos.models.ThroughputSettingsUpdateParameters;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for MongoDBResources UpdateMongoDBDatabaseThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBMongoDBDatabaseThroughputUpdate.json
     */
    /**
     * Sample code: CosmosDBMongoDBDatabaseThroughputUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBDatabaseThroughputUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().updateMongoDBDatabaseThroughput(
            "rg1", "ddb1", "databaseName", new ThroughputSettingsUpdateParameters().withLocation("West US")
                .withTags(mapOf()).withResource(new ThroughputSettingsResource().withThroughput(400)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_mongo_db_database_throughput_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.mongo_db_resources.begin_update_mongo_db_database_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
        update_throughput_parameters={
            "location": "West US",
            "properties": {"resource": {"throughput": 400}},
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json
func ExampleMongoDBResourcesClient_BeginUpdateMongoDBDatabaseThroughput() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewMongoDBResourcesClient().BeginUpdateMongoDBDatabaseThroughput(ctx, "rg1", "ddb1", "databaseName", armcosmos.ThroughputSettingsUpdateParameters{
		Location: to.Ptr("West US"),
		Tags:     map[string]*string{},
		Properties: &armcosmos.ThroughputSettingsUpdateProperties{
			Resource: &armcosmos.ThroughputSettingsResource{
				Throughput: to.Ptr[int32](400),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ThroughputSettingsGetResults = armcosmos.ThroughputSettingsGetResults{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcosmos.ThroughputSettingsGetProperties{
	// 		Resource: &armcosmos.ThroughputSettingsGetPropertiesResource{
	// 			Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
	// 			Rid: to.Ptr("PD5DALigDgw="),
	// 			Ts: to.Ptr[float32](1459200611),
	// 			MinimumThroughput: to.Ptr("400"),
	// 			OfferReplacePending: to.Ptr("true"),
	// 			Throughput: to.Ptr[int32](400),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update RUs per second of the an Azure Cosmos DB MongoDB database
 *
 * @summary Update RUs per second of the an Azure Cosmos DB MongoDB database
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json
 */
async function cosmosDbMongoDbdatabaseThroughputUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const updateThroughputParameters = {
    location: "West US",
    resource: { throughput: 400 },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.beginUpdateMongoDBDatabaseThroughputAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    updateThroughputParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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\""
    }
  }
}

Status code:: 202

Definicje

Nazwa	Opis
AutoscaleSettingsResource	Obiekt ustawień aprowizowanej przepływności usługi Cosmos DB
AutoUpgradePolicyResource	Zasady automatycznego uaktualniania zasobów usługi Cosmos DB
CloudError	Odpowiedź na błąd z usługi.
ErrorResponse	Odpowiedź na błąd.
Resource
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.

AutoscaleSettingsResource

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

Nazwa	Typ	Opis
autoUpgradePolicy	AutoUpgradePolicyResource	Zasady automatycznego uaktualniania zasobów usługi Cosmos DB
maxThroughput	integer	Reprezentuje maksymalny kontener przepływności, który można skalować w górę.
targetMaxThroughput	integer	Reprezentuje docelowy kontener maksymalnej przepływności można skalować w górę do momentu, gdy oferta nie jest już w stanie oczekiwania.

AutoUpgradePolicyResource

Zasady automatycznego uaktualniania zasobów usługi Cosmos DB

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

CloudError

Odpowiedź na błąd z usługi.

Nazwa	Typ	Opis
error	ErrorResponse	Odpowiedź na błąd.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

Resource

Nazwa	Typ	Opis
_etag	string	Właściwość wygenerowana przez system reprezentująca tag zasobu wymagany do optymistycznej kontroli 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 ostatnio zaktualizowany znacznik czasu zasobu.
autoscaleSettings	AutoscaleSettingsResource	Zasób usługi Cosmos DB dla ustawień skalowania automatycznego. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.
instantMaximumThroughput	string	Wartość przepływności oferty do natychmiastowego skalowania w górę bez wyzwalania podziałów
minimumThroughput	string	Minimalna przepływność zasobu
offerReplacePending	string	Oczekiwanie na zastąpienie przepływności
softAllowedMaximumThroughput	string	Maksymalna wartość przepływności lub maksymalna wartość maxThroughput (dla autoskalowania), którą można określić
throughput	integer	Wartość przepływności zasobów usługi Cosmos DB. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.

ThroughputPolicyResource

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

Nazwa	Typ	Opis
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 element ThroughputPolicy jest aktywny, czy nie

ThroughputSettingsGetResults

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

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu usługi ARM.
location	string	Lokalizacja grupy zasobów, do której należy zasób.
name	string	Nazwa zasobu usługi ARM.
properties.resource	Resource
tags	object	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".
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.

Nazwa	Typ	Opis
autoscaleSettings	AutoscaleSettingsResource	Zasób usługi Cosmos DB dla ustawień skalowania automatycznego. Wymagana jest przepływność lub autoskalowanieUstawienia jest wymagane, ale nie oba.
instantMaximumThroughput	string	Wartość przepływności oferty do natychmiastowego skalowania w górę bez wyzwalania podziałów
minimumThroughput	string	Minimalna przepływność zasobu
offerReplacePending	string	Oczekiwanie na zastąpienie przepływności
softAllowedMaximumThroughput	string	Maksymalna wartość przepływności lub maksymalna wartość maxThroughput (dla autoskalowania), którą można określić
throughput	integer	Wartość 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.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator zasobu usługi ARM.
location	string	Lokalizacja grupy zasobów, do której należy zasób.
name	string	Nazwa zasobu usługi ARM.
properties.resource	ThroughputSettingsResource	Standardowy format JSON przepływności zasobów
tags	object	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".
type	string	Typ zasobu platformy Azure.

Mongo DB Resources - Update Mongo DB Database Throughput

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Scopes

Przykłady

CosmosDBMongoDBDatabaseThroughputUpdate

Sample Request

Sample Response

Definicje

AutoscaleSettingsResource

AutoUpgradePolicyResource

CloudError

ErrorResponse

Resource

ThroughputPolicyResource

ThroughputSettingsGetResults

ThroughputSettingsResource

ThroughputSettingsUpdateParameters

Dodatkowe zasoby