Mongo DB Resources - Update Mongo DB Collection Throughput

Dienst:

Cosmos DB Resource Provider

API-Version:

2025-10-15

Aktualisieren der RUs pro Sekunde einer MongoDB-Sammlung von 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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Name des Cosmos DB-Datenbankkontos.
collectionName	path	True	string	Name der Cosmos DB-Sammlung.
databaseName	path	True	string	Name der Cosmos DB-Datenbank.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
updateThroughputParameters	ThroughputSettingsUpdateParameters	Die RUs pro Sekunde der Parameter, die für die aktuelle MongoDB-Sammlung bereitgestellt werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	ThroughputSettingsGetResults	Die RUs pro Sekunde des Aktualisierungsvorgangs für die MongoDB-Sammlung wurden erfolgreich abgeschlossen.
202 Accepted		Die RUs pro Sekunde des Aktualisierungsvorgangs für die MongoDB-Sammlung werden asynchron abgeschlossen. Header azure-AsyncOperation: string location: string

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBMongoDBCollectionThroughputUpdate

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

202

Definitionen

Name	Beschreibung
AutoscaleSettingsResource	Objekt der von Cosmos DB bereitgestellten Durchsatzeinstellungen
AutoUpgradePolicyResource	Cosmos DB-Ressourcenrichtlinie für automatische Upgrades
Resource
ThroughputPolicyResource	Richtlinie für den Ressourcendurchsatz in Cosmos DB
ThroughputSettingsGetResults	Ein Azure Cosmos DB-Ressourcendurchsatz.
ThroughputSettingsResource	Cosmos DB-Ressourcendurchsatzobjekt. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides.
ThroughputSettingsUpdateParameters	Die RUs pro Sekunde der Parameter, die für die aktuelle MongoDB-Sammlung bereitgestellt werden sollen.

AutoscaleSettingsResource

Objekt

Objekt der von Cosmos DB bereitgestellten Durchsatzeinstellungen

Name	Typ	Beschreibung
autoUpgradePolicy	AutoUpgradePolicyResource	Cosmos DB-Ressourcenrichtlinie für automatische Upgrades
maxThroughput	integer	Stellt den maximalen Durchsatzcontainer dar, der bis zu skalieren kann.
targetMaxThroughput	integer	Stellt den maximalen Zieldurchsatz dar, auf den der Container hochskaliert werden kann, sobald sich das Angebot nicht mehr im Status "Ausstehend" befindet.

AutoUpgradePolicyResource

Objekt

Cosmos DB-Ressourcenrichtlinie für automatische Upgrades

Name	Typ	Beschreibung
throughputPolicy	ThroughputPolicyResource	Stellt die Durchsatzrichtlinie dar, der der Dienst für das automatische Upgrade einhalten muss.

Resource

Objekt

Name	Typ	Beschreibung
_etag	string	Eine vom System generierte Eigenschaft, die das Ressourcen-ETAG darstellt, das für die Steuerung der optimistischen Parallelität erforderlich ist.
_rid	string	Eine vom System generierte Eigenschaft. Eine eindeutige Kennung.
_ts	number	Eine vom System generierte Eigenschaft, die den zuletzt aktualisierten Zeitstempel der Ressource angibt.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-Ressource für Autoskaleneinstellungen. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides.
instantMaximumThroughput	string	Der Durchsatzwert des Angebots für eine sofortige Skalierung, ohne dass Splits ausgelöst werden müssen
minimumThroughput	string	Der minimale Durchsatz der Ressource
offerReplacePending	string	Die Ersetzung des Durchsatzes steht noch aus
softAllowedMaximumThroughput	string	Der maximale Durchsatzwert oder der maximale maxThroughput-Wert (für die automatische Skalierung), der angegeben werden kann
throughput	integer	Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides.

ThroughputPolicyResource

Objekt

Richtlinie für den Ressourcendurchsatz in Cosmos DB

Name	Typ	Beschreibung
incrementPercent	integer	Stellt den Prozentsatz dar, um den der Durchsatz bei jedem Start der Durchsatzrichtlinie erhöht werden kann.
isEnabled	boolean	Bestimmt, ob die Durchsatzpolicy aktiv ist oder nicht.

ThroughputSettingsGetResults

Objekt

Ein Azure Cosmos DB-Ressourcendurchsatz.

Name	Typ	Beschreibung
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
location	string	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
name	string	Der Name der ARM-Ressource.
properties.resource	Resource
tags	object	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Jedes Tag muss einen Schlüssel haben, der nicht größer als 128 Zeichen ist, und der Wert darf maximal 256 Zeichen lang sein. Die Standardoberfläche für einen Vorlagentyp wird z. B. mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".
type	string	Der Typ der Azure-Ressource.

ThroughputSettingsResource

Objekt

Cosmos DB-Ressourcendurchsatzobjekt. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides.

Name	Typ	Beschreibung
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-Ressource für Autoskaleneinstellungen. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides.
instantMaximumThroughput	string	Der Durchsatzwert des Angebots für eine sofortige Skalierung, ohne dass Splits ausgelöst werden müssen
minimumThroughput	string	Der minimale Durchsatz der Ressource
offerReplacePending	string	Die Ersetzung des Durchsatzes steht noch aus
softAllowedMaximumThroughput	string	Der maximale Durchsatzwert oder der maximale maxThroughput-Wert (für die automatische Skalierung), der angegeben werden kann
throughput	integer	Wert des Cosmos DB-Ressourcendurchsatzes. Entweder ist der Durchsatz erforderlich, oder autoscaleSettings ist erforderlich, aber nicht beides.

ThroughputSettingsUpdateParameters

Objekt

Die RUs pro Sekunde der Parameter, die für die aktuelle MongoDB-Sammlung bereitgestellt werden sollen.

Name	Typ	Beschreibung
id	string	Der eindeutige Ressourcenbezeichner der ARM-Ressource.
location	string	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
name	string	Der Name der ARM-Ressource.
properties.resource	ThroughputSettingsResource	Das standardmäßige JSON-Format eines Ressourcendurchsatzes
tags	object	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Jedes Tag muss einen Schlüssel haben, der nicht größer als 128 Zeichen ist, und der Wert darf maximal 256 Zeichen lang sein. Die Standardoberfläche für einen Vorlagentyp wird z. B. mit "defaultExperience": "Cassandra" festgelegt. Zu den aktuellen "defaultExperience"-Werten gehören auch "Table", "Graph", "DocumentDB" und "MongoDB".
type	string	Der Typ der Azure-Ressource.