Mongo DB Resources - Update Mongo DB Collection Throughput

Service:

Cosmos DB Resource Provider

API-versie:

2025-10-15

De RU's per seconde van een Azure Cosmos DB MongoDB-verzameling bijwerken

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-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Accountnaam van de Cosmos DB-database.
collectionName	path	True	string	Naam van de Cosmos DB-collectie.
databaseName	path	True	string	Naam van de Cosmos DB-database.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
updateThroughputParameters	ThroughputSettingsUpdateParameters	De RU's per seconde van de parameters die moeten worden verstrekt voor de huidige MongoDB-verzameling.

Antwoorden

Name	Type	Description
200 OK	ThroughputSettingsGetResults	De RU's per seconde van de MongoDB-verzamelingsupdatebewerking zijn voltooid.
202 Accepted		De RU's per seconde van de updatebewerking van de MongoDB-collectie worden asynchroon voltooid. Kopteksten azure-AsyncOperation: string location: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CosmosDBMongoDBCollectionThroughputUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AutoscaleSettingsResource	Object met instellingen voor door Cosmos DB ingerichte doorvoer
AutoUpgradePolicyResource	Beleid voor automatische upgrade van Cosmos DB-resources
Resource
ThroughputPolicyResource	Beleid voor doorvoer van Cosmos DB-resources
ThroughputSettingsGetResults	Een doorvoer van Azure Cosmos DB-resources.
ThroughputSettingsResource	Cosmos DB-resource doorvoerobject. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide.
ThroughputSettingsUpdateParameters	De RU's per seconde van de parameters die moeten worden verstrekt voor de huidige MongoDB-verzameling.

AutoscaleSettingsResource

Object

Object met instellingen voor door Cosmos DB ingerichte doorvoer

Name	Type	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Beleid voor automatische upgrade van Cosmos DB-resources
maxThroughput	integer	Vertegenwoordigt de maximale doorvoercontainer die omhoog kan worden geschaald.
targetMaxThroughput	integer	Vertegenwoordigt het doel van de maximale doorvoer waartoe de container kan worden opgeschaald zodra de aanbieding niet meer in behandeling is.

AutoUpgradePolicyResource

Object

Beleid voor automatische upgrade van Cosmos DB-resources

Name	Type	Description
throughputPolicy	ThroughputPolicyResource	Vertegenwoordigt doorvoerbeleid waaraan de service moet voldoen voor automatische upgrade

Resource

Object

Name	Type	Description
_etag	string	Een door het systeem gegenereerde eigenschap die de resource-etag vertegenwoordigt die nodig is voor optimistische gelijktijdigheidscontrole.
_rid	string	Een door het systeem gegenereerde eigenschap. Een unieke identificatiecode.
_ts	number	Een door het systeem gegenereerde eigenschap die de laatst bijgewerkte tijdstempel van de resource aangeeft.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-resource voor instellingen voor automatisch schalen. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide.
instantMaximumThroughput	string	De bieden doorvoerwaarde om direct op te schalen zonder splitsingen te triggeren
minimumThroughput	string	De minimale doorvoer van de resource
offerReplacePending	string	De vervanging van de doorvoer is in afwachting
softAllowedMaximumThroughput	string	De maximale doorvoerwaarde of de maximale maxThroughput-waarde (voor automatisch schalen) die kan worden opgegeven
throughput	integer	Waarde van de doorvoer van cosmos DB-resources. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide.

ThroughputPolicyResource

Object

Beleid voor doorvoer van Cosmos DB-resources

Name	Type	Description
incrementPercent	integer	Vertegenwoordigt het percentage waarmee doorvoer kan toenemen telkens wanneer het doorvoerbeleid wordt geactiveerd.
isEnabled	boolean	Bepaalt of doorvoerbeleid actief is of niet

ThroughputSettingsGetResults

Object

Een doorvoer van Azure Cosmos DB-resources.

Name	Type	Description
id	string	De unieke resource-id van de ARM-resource.
location	string	De locatie van de resourcegroep waartoe de resource behoort.
name	string	De naam van de ARM-bron.
properties.resource	Resource
tags	object	Tags zijn een lijst met sleutel-waardeparen die de bron beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben van maximaal 128 tekens en een waarde van maximaal 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. De huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.
type	string	Het type Azure-resource.

ThroughputSettingsResource

Object

Cosmos DB-resource doorvoerobject. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide.

Name	Type	Description
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-resource voor instellingen voor automatisch schalen. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide.
instantMaximumThroughput	string	De bieden doorvoerwaarde om direct op te schalen zonder splitsingen te triggeren
minimumThroughput	string	De minimale doorvoer van de resource
offerReplacePending	string	De vervanging van de doorvoer is in afwachting
softAllowedMaximumThroughput	string	De maximale doorvoerwaarde of de maximale maxThroughput-waarde (voor automatisch schalen) die kan worden opgegeven
throughput	integer	Waarde van de doorvoer van cosmos DB-resources. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide.

ThroughputSettingsUpdateParameters

Object

De RU's per seconde van de parameters die moeten worden verstrekt voor de huidige MongoDB-verzameling.

Name	Type	Description
id	string	De unieke resource-id van de ARM-resource.
location	string	De locatie van de resourcegroep waartoe de resource behoort.
name	string	De naam van de ARM-bron.
properties.resource	ThroughputSettingsResource	De standaard JSON-indeling van een resourcedoorvoer
tags	object	Tags zijn een lijst met sleutel-waardeparen die de bron beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben van maximaal 128 tekens en een waarde van maximaal 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. De huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.
type	string	Het type Azure-resource.