Mongo DB Resources - Update Mongo DB Collection Throughput

Tjänst:

Cosmos DB Resource Provider

API-versionen:

2025-10-15

Uppdatera RU:er per sekund för en Azure Cosmos DB MongoDB-samling

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

Namn	I	Krävs	Typ	Beskrivning
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Namn på Cosmos DB-databaskonto.
collectionName	path	True	string	Cosmos DB samlingsnamn.
databaseName	path	True	string	Cosmos DB databasnamn.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begäranarorgan

Namn	Typ	Beskrivning
updateThroughputParameters	ThroughputSettingsUpdateParameters	RU:er per sekund för parametrarna som ska tillhandahållas för den aktuella MongoDB-samlingen.

Svaren

Namn	Typ	Beskrivning
200 OK	ThroughputSettingsGetResults	RU:erna per sekund för uppdateringsåtgärden för MongoDB-samlingen har slutförts.
202 Accepted		RU:erna per sekund för uppdateringsåtgärden för MongoDB-samlingen slutförs asynkront. Headers azure-AsyncOperation: string location: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	Personifiera ditt användarkonto

Exempel

CosmosDBMongoDBCollectionThroughputUpdate

Exempelförfrågan

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

Exempelsvar

Statuskod:

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

Statuskod:

202

Definitioner

Namn	Beskrivning
AutoscaleSettingsResource	Cosmos DB objekt för etablerade dataflödesinställningar
AutoUpgradePolicyResource	Princip för automatisk uppgradering av Cosmos DB-resurser
Resource
ThroughputPolicyResource	Princip för Cosmos DB-resursdataflöde
ThroughputSettingsGetResults	Ett dataflöde för Azure Cosmos DB-resursen.
ThroughputSettingsResource	Cosmos DB resurs dataflödes objekt. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.
ThroughputSettingsUpdateParameters	RU:er per sekund för parametrarna som ska tillhandahållas för den aktuella MongoDB-samlingen.

AutoscaleSettingsResource

Objekt

Cosmos DB objekt för etablerade dataflödesinställningar

Namn	Typ	Beskrivning
autoUpgradePolicy	AutoUpgradePolicyResource	Princip för automatisk uppgradering av Cosmos DB-resurser
maxThroughput	integer	Representerar maximalt dataflöde som containern kan skala upp till.
targetMaxThroughput	integer	Representerar det maximala dataflöde som containern kan skalas upp till när erbjudandet inte längre är i väntande tillstånd.

AutoUpgradePolicyResource

Objekt

Princip för automatisk uppgradering av Cosmos DB-resurser

Namn	Typ	Beskrivning
throughputPolicy	ThroughputPolicyResource	Representerar den dataflödesprincip som tjänsten måste följa för automatisk uppgradering

Resource

Objekt

Namn	Typ	Beskrivning
_etag	string	En systemgenererad egenskap som representerar den resurstagg som krävs för optimistisk samtidighetskontroll.
_rid	string	En systemgenererad egenskap. En unik identifierare.
_ts	number	En systemgenererad egenskap som anger den senast uppdaterade tidsstämpeln för resursen.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-resurs för autoskalningsinställningar. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.
instantMaximumThroughput	string	Erbjudandets dataflödesvärde för att omedelbart skala upp utan att utlösa delningar
minimumThroughput	string	Minsta dataflöde för resursen
offerReplacePending	string	Ersättandet av dataflödet väntar
softAllowedMaximumThroughput	string	Det maximala dataflödesvärdet eller det maximala maxThroughput-värdet (för autoskalning) som kan anges
throughput	integer	Värdet för Cosmos DB-resursens dataflöde. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.

ThroughputPolicyResource

Objekt

Princip för Cosmos DB-resursdataflöde

Namn	Typ	Beskrivning
incrementPercent	integer	Representerar den procentandel med vilken dataflödet kan öka varje gång dataflödesprincipen startar.
isEnabled	boolean	Avgör om ThroughputPolicy är aktiv eller inte

ThroughputSettingsGetResults

Objekt

Ett dataflöde för Azure Cosmos DB-resursen.

Namn	Typ	Beskrivning
id	string	Den unika resursidentifieraren för ARM-resursen.
location	string	Platsen för den resursgrupp som resursen tillhör.
name	string	Namnet på ARM-resursen.
properties.resource	Resource
tags	object	Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".
type	string	Typ av Azure-resurs.

ThroughputSettingsResource

Objekt

Cosmos DB resurs dataflödes objekt. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.

Namn	Typ	Beskrivning
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-resurs för autoskalningsinställningar. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.
instantMaximumThroughput	string	Erbjudandets dataflödesvärde för att omedelbart skala upp utan att utlösa delningar
minimumThroughput	string	Minsta dataflöde för resursen
offerReplacePending	string	Ersättandet av dataflödet väntar
softAllowedMaximumThroughput	string	Det maximala dataflödesvärdet eller det maximala maxThroughput-värdet (för autoskalning) som kan anges
throughput	integer	Värdet för Cosmos DB-resursens dataflöde. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.

ThroughputSettingsUpdateParameters

Objekt

RU:er per sekund för parametrarna som ska tillhandahållas för den aktuella MongoDB-samlingen.

Namn	Typ	Beskrivning
id	string	Den unika resursidentifieraren för ARM-resursen.
location	string	Platsen för den resursgrupp som resursen tillhör.
name	string	Namnet på ARM-resursen.
properties.resource	ThroughputSettingsResource	JSON-standardformatet för ett resursdataflöde
tags	object	Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".
type	string	Typ av Azure-resurs.