Mongo DB Resources - Update Mongo DB Collection Throughput

Služba:

Cosmos DB Resource Provider

Verze rozhraní API:

2025-10-15

Aktualizace počtu jednotek RU za sekundu v kolekci MongoDB služby Azure Cosmos DB

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Název účtu databáze Cosmos DB.
collectionName	path	True	string	Název kolekce Cosmos DB.
databaseName	path	True	string	Název databáze Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
subscriptionId	path	True	string minLength: 1	ID cílového předplatného.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
updateThroughputParameters	ThroughputSettingsUpdateParameters	Počet RU za sekundu parametrů, které mají být poskytnuty pro aktuální kolekci MongoDB.

Odpovědi

Name	Typ	Description
200 OK	ThroughputSettingsGetResults	Počet RU za sekundu operace aktualizace kolekce MongoDB byl úspěšně dokončen.
202 Accepted		Počet jednotek RU za sekundu operace aktualizace kolekce MongoDB se dokončí asynchronně. Hlavičky azure-AsyncOperation: string location: string

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Příklady

CosmosDBMongoDBCollectionThroughputUpdate

Ukázkový požadavek

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/collections/collectionName/throughputSettings/default?api-version=2025-10-15

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

Java

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 UpdateMongoDBCollectionThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/
     * CosmosDBMongoDBCollectionThroughputUpdate.json
     */
    /**
     * Sample code: CosmosDBMongoDBCollectionThroughputUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBCollectionThroughputUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().updateMongoDBCollectionThroughput(
            "rg1", "ddb1", "databaseName", "collectionName",
            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

Python

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_collection_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_collection_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
        collection_name="collectionName",
        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/DocumentDB/stable/2025-10-15/examples/CosmosDBMongoDBCollectionThroughputUpdate.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

Go

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/8b53f9cfc1fdb24dbfa28e311d3be4c645169297/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBMongoDBCollectionThroughputUpdate.json
func ExampleMongoDBResourcesClient_BeginUpdateMongoDBCollectionThroughput() {
	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().BeginUpdateMongoDBCollectionThroughput(ctx, "rg1", "ddb1", "databaseName", "collectionName", 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/mongodbCollections/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName/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

JavaScript

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

/**
 * This sample demonstrates how to Update the RUs per second of an Azure Cosmos DB MongoDB collection
 *
 * @summary Update the RUs per second of an Azure Cosmos DB MongoDB collection
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBMongoDBCollectionThroughputUpdate.json
 */
async function cosmosDbMongoDbcollectionThroughputUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const collectionName = "collectionName";
  const updateThroughputParameters = {
    location: "West US",
    resource: { throughput: 400 },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.beginUpdateMongoDBCollectionThroughputAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    collectionName,
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CosmosDB.Models;
using Azure.ResourceManager.CosmosDB;

// Generated from example definition: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBMongoDBCollectionThroughputUpdate.json
// this example is just showing the usage of "MongoDBResources_UpdateMongoDBCollectionThroughput" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MongoDBCollectionThroughputSettingResource created on azure
// for more information of creating MongoDBCollectionThroughputSettingResource, please refer to the document of MongoDBCollectionThroughputSettingResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string accountName = "ddb1";
string databaseName = "databaseName";
string collectionName = "collectionName";
ResourceIdentifier mongoDBCollectionThroughputSettingResourceId = MongoDBCollectionThroughputSettingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, databaseName, collectionName);
MongoDBCollectionThroughputSettingResource mongoDBCollectionThroughputSetting = client.GetMongoDBCollectionThroughputSettingResource(mongoDBCollectionThroughputSettingResourceId);

// invoke the operation
ThroughputSettingsUpdateData data = new ThroughputSettingsUpdateData(new AzureLocation("West US"), new ThroughputSettingsResourceInfo
{
    Throughput = 400,
})
{
    Tags = { },
};
ArmOperation<MongoDBCollectionThroughputSettingResource> lro = await mongoDBCollectionThroughputSetting.CreateOrUpdateAsync(WaitUntil.Completed, data);
MongoDBCollectionThroughputSettingResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ThroughputSettingData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Ukázková odpověď

Stavový kód:

200

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

Stavový kód:

202

Definice

Name	Description
AutoscaleSettingsResource	Objekt nastavení zřízené propustnosti služby Cosmos DB
AutoUpgradePolicyResource	Zásady automatického upgradu prostředků Cosmos DB
Resource
ThroughputPolicyResource	Zásady propustnosti prostředků Cosmos DB
ThroughputSettingsGetResults	Propustnost prostředků Azure Cosmos DB.
ThroughputSettingsResource	Objekt propustnosti prostředků Cosmos DB. Vyžaduje se propustnost nebo je vyžadováno automatické škálování, ale ne obojí.
ThroughputSettingsUpdateParameters	Počet RU za sekundu parametrů, které mají být poskytnuty pro aktuální kolekci MongoDB.

AutoscaleSettingsResource

Objekt

Objekt nastavení zřízené propustnosti služby Cosmos DB

Name	Typ	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Zásady automatického upgradu prostředků Cosmos DB
maxThroughput	integer	Představuje maximální propustnost kontejneru, na který lze vertikálně navýšit kapacitu.
targetMaxThroughput	integer	Představuje cílovou maximální propustnost, kterou může kontejner vertikálně navýšit až na jednou, nabídka již není ve stavu čekání na vyřízení.

AutoUpgradePolicyResource

Objekt

Zásady automatického upgradu prostředků Cosmos DB

Name	Typ	Description
throughputPolicy	ThroughputPolicyResource	Představuje zásady propustnosti, které služba musí dodržovat pro automatický upgrade.

Resource

Objekt

Name	Typ	Description
_etag	string	Systémem generovaná vlastnost představující značku prostředku vyžadovanou pro optimistické řízení souběžnosti.
_rid	string	Systémem generovaná vlastnost. Jedinečný identifikátor.
_ts	number	Systémem generovaná vlastnost, která označuje časové razítko poslední aktualizace zdroje.
autoscaleSettings	AutoscaleSettingsResource	Prostředek Cosmos DB pro nastavení automatického škálování Vyžaduje se propustnost nebo je vyžadováno automatické škálování, ale ne obojí.
instantMaximumThroughput	string	Hodnota propustnosti nabídky pro okamžité škálování bez spouštění rozdělení
minimumThroughput	string	Minimální propustnost prostředku
offerReplacePending	string	Nahrazení propustnosti čeká na vyřízení
softAllowedMaximumThroughput	string	Hodnota maximální propustnosti nebo maximální hodnota maxThroughput (pro automatické škálování), kterou je možné zadat
throughput	integer	Hodnota propustnosti prostředku Cosmos DB Vyžaduje se propustnost nebo je vyžadováno automatické škálování, ale ne obojí.

ThroughputPolicyResource

Objekt

Zásady propustnosti prostředků Cosmos DB

Name	Typ	Description
incrementPercent	integer	Představuje procento, o které se propustnost může zvýšit při každém spuštění zásad propustnosti.
isEnabled	boolean	Určuje, jestli je zásada propustnosti aktivní, nebo ne.

ThroughputSettingsGetResults

Objekt

Propustnost prostředků Azure Cosmos DB.

Name	Typ	Description
id	string	Jedinečný identifikátor prostředku ARM.
location	string	Umístění skupiny prostředků, do které prostředek patří.
name	string	Název prostředku ARM.
properties.resource	Resource
tags	object	Značky jsou seznamem párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč maximálně 128 znaků a nesmí mít hodnotu větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastaveno na "defaultExperience": "Cassandra". Aktuální hodnoty "defaultExperience" zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB".
type	string	Typ prostředku Azure.

ThroughputSettingsResource

Objekt

Objekt propustnosti prostředků Cosmos DB. Vyžaduje se propustnost nebo je vyžadováno automatické škálování, ale ne obojí.

Name	Typ	Description
autoscaleSettings	AutoscaleSettingsResource	Prostředek Cosmos DB pro nastavení automatického škálování Vyžaduje se propustnost nebo je vyžadováno automatické škálování, ale ne obojí.
instantMaximumThroughput	string	Hodnota propustnosti nabídky pro okamžité škálování bez spouštění rozdělení
minimumThroughput	string	Minimální propustnost prostředku
offerReplacePending	string	Nahrazení propustnosti čeká na vyřízení
softAllowedMaximumThroughput	string	Hodnota maximální propustnosti nebo maximální hodnota maxThroughput (pro automatické škálování), kterou je možné zadat
throughput	integer	Hodnota propustnosti prostředku Cosmos DB Vyžaduje se propustnost nebo je vyžadováno automatické škálování, ale ne obojí.

ThroughputSettingsUpdateParameters

Objekt

Počet RU za sekundu parametrů, které mají být poskytnuty pro aktuální kolekci MongoDB.

Name	Typ	Description
id	string	Jedinečný identifikátor prostředku ARM.
location	string	Umístění skupiny prostředků, do které prostředek patří.
name	string	Název prostředku ARM.
properties.resource	ThroughputSettingsResource	Standardní formát JSON propustnosti prostředku
tags	object	Značky jsou seznamem párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč maximálně 128 znaků a nesmí mít hodnotu větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastaveno na "defaultExperience": "Cassandra". Aktuální hodnoty "defaultExperience" zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB".
type	string	Typ prostředku Azure.