Mongo DB Resources - Update Mongo DB Collection Throughput

Servizio:

Cosmos DB Resource Provider

Versione API:

2025-10-15

Aggiornare le UR al secondo di una raccolta MongoDB di 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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome dell'account del database Cosmos DB.
collectionName	path	True	string	Nome della raccolta Cosmos DB.
databaseName	path	True	string	Nome del database Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
updateThroughputParameters	ThroughputSettingsUpdateParameters	UR al secondo dei parametri da fornire per la raccolta MongoDB corrente.

Risposte

Nome	Tipo	Descrizione
200 OK	ThroughputSettingsGetResults	Le UR al secondo dell'operazione di aggiornamento della raccolta MongoDB sono state completate correttamente.
202 Accepted		Le UR al secondo dell'operazione di aggiornamento della raccolta MongoDB verranno completate in modo asincrono. Intestazioni azure-AsyncOperation: string location: string

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Esempio

CosmosDBMongoDBCollectionThroughputUpdate

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

202

Definizioni

Nome	Descrizione
AutoscaleSettingsResource	Oggetto delle impostazioni della velocità effettiva di cui è stato effettuato il provisioning di Cosmos DB
AutoUpgradePolicyResource	Criteri di aggiornamento automatico delle risorse di Cosmos DB
Resource
ThroughputPolicyResource	Criteri di velocità effettiva delle risorse di Cosmos DB
ThroughputSettingsGetResults	Velocità effettiva delle risorse di Azure Cosmos DB.
ThroughputSettingsResource	Oggetto velocità effettiva delle risorse Cosmos DB. La velocità effettiva è obbligatoria o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe.
ThroughputSettingsUpdateParameters	UR al secondo dei parametri da fornire per la raccolta MongoDB corrente.

AutoscaleSettingsResource

Oggetto

Oggetto delle impostazioni della velocità effettiva di cui è stato effettuato il provisioning di Cosmos DB

Nome	Tipo	Descrizione
autoUpgradePolicy	AutoUpgradePolicyResource	Criteri di aggiornamento automatico delle risorse di Cosmos DB
maxThroughput	integer	Rappresenta il contenitore di velocità effettiva massima in grado di aumentare le prestazioni.
targetMaxThroughput	integer	Rappresenta la velocità effettiva massima di destinazione, il contenitore può essere scalato fino a quando l'offerta non è più in sospeso.

AutoUpgradePolicyResource

Oggetto

Criteri di aggiornamento automatico delle risorse di Cosmos DB

Nome	Tipo	Descrizione
throughputPolicy	ThroughputPolicyResource	Rappresenta i criteri di velocità effettiva a cui il servizio deve rispettare per l'aggiornamento automatico

Resource

Oggetto

Nome	Tipo	Descrizione
_etag	string	Proprietà generata dal sistema che rappresenta l'etag della risorsa necessario per il controllo della concorrenza ottimistica.
_rid	string	Proprietà generata dal sistema. Un identificatore univoco.
_ts	number	Proprietà generata dal sistema che indica l'ultimo timestamp aggiornato della risorsa.
autoscaleSettings	AutoscaleSettingsResource	Risorsa Cosmos DB per le impostazioni di scalabilità automatica. La velocità effettiva è obbligatoria o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe.
instantMaximumThroughput	string	Il valore del throughput dell'offerta per aumentare istantaneamente senza attivare divisioni
minimumThroughput	string	Velocità effettiva minima della risorsa
offerReplacePending	string	La sostituzione del throughput è in sospeso
softAllowedMaximumThroughput	string	Valore di velocità effettiva massima o valore di velocità effettiva massima (per la scalabilità automatica) che è possibile specificare
throughput	integer	Valore della velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è obbligatoria o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe.

ThroughputPolicyResource

Oggetto

Criteri di velocità effettiva delle risorse di Cosmos DB

Nome	Tipo	Descrizione
incrementPercent	integer	Rappresenta la percentuale in base alla quale la velocità effettiva può aumentare ogni volta che viene attivato il criterio di velocità effettiva.
isEnabled	boolean	Determina se ThroughputPolicy è attivo o meno

ThroughputSettingsGetResults

Oggetto

Velocità effettiva delle risorse di Azure Cosmos DB.

Nome	Tipo	Descrizione
id	string	Identificatore univoco della risorsa ARM.
location	string	Posizione del gruppo di risorse a cui appartiene la risorsa.
name	string	Nome della risorsa ARM.
properties.resource	Resource
tags	object	I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere usati per visualizzare e raggruppare questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non maggiore di 128 caratteri e un valore non maggiore di 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti di "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".
type	string	Tipo di risorsa di Azure.

ThroughputSettingsResource

Oggetto

Oggetto velocità effettiva delle risorse Cosmos DB. La velocità effettiva è obbligatoria o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe.

Nome	Tipo	Descrizione
autoscaleSettings	AutoscaleSettingsResource	Risorsa Cosmos DB per le impostazioni di scalabilità automatica. La velocità effettiva è obbligatoria o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe.
instantMaximumThroughput	string	Il valore del throughput dell'offerta per aumentare istantaneamente senza attivare divisioni
minimumThroughput	string	Velocità effettiva minima della risorsa
offerReplacePending	string	La sostituzione del throughput è in sospeso
softAllowedMaximumThroughput	string	Valore di velocità effettiva massima o valore di velocità effettiva massima (per la scalabilità automatica) che è possibile specificare
throughput	integer	Valore della velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è obbligatoria o la scalabilità automaticaImpostazioni è obbligatoria, ma non entrambe.

ThroughputSettingsUpdateParameters

Oggetto

UR al secondo dei parametri da fornire per la raccolta MongoDB corrente.

Nome	Tipo	Descrizione
id	string	Identificatore univoco della risorsa ARM.
location	string	Posizione del gruppo di risorse a cui appartiene la risorsa.
name	string	Nome della risorsa ARM.
properties.resource	ThroughputSettingsResource	Formato JSON standard di una velocità effettiva delle risorse
tags	object	I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere usati per visualizzare e raggruppare questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non maggiore di 128 caratteri e un valore non maggiore di 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti di "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".
type	string	Tipo di risorsa di Azure.