Mongo DB Resources - Update Mongo DB Collection Throughput

Serviço:

Cosmos DB Resource Provider

Versão da API:

2025-10-15

Atualizar as RUs por segundo de uma coleção MongoDB do 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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome da conta do banco de dados do Cosmos DB.
collectionName	path	True	string	Nome da coleção do Cosmos DB.
databaseName	path	True	string	Nome do banco de dados do Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
updateThroughputParameters	ThroughputSettingsUpdateParameters	As RUs por segundo dos parâmetros a serem fornecidos para a coleção atual do MongoDB.

Respostas

Nome	Tipo	Description
200 OK	ThroughputSettingsGetResults	As RUs por segundo da operação de atualização de coleção do MongoDB foram concluídas com êxito.
202 Accepted		As RUs por segundo da operação de atualização da coleção do MongoDB serão concluídas de forma assíncrona. Cabeçalhos azure-AsyncOperation: string location: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	Representar sua conta de usuário

Exemplos

CosmosDBMongoDBCollectionThroughputUpdate

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Código de status:

202

Definições

Nome	Description
AutoscaleSettingsResource	Objeto de configurações de taxa de transferência provisionada do Cosmos DB
AutoUpgradePolicyResource	Política de atualização automática de recursos do Cosmos DB
Resource
ThroughputPolicyResource	Política de taxa de transferência de recursos do Cosmos DB
ThroughputSettingsGetResults	Uma taxa de transferência de recursos do Azure Cosmos DB.
ThroughputSettingsResource	Objeto de taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático É necessário, mas não ambos.
ThroughputSettingsUpdateParameters	As RUs por segundo dos parâmetros a serem fornecidos para a coleção atual do MongoDB.

AutoscaleSettingsResource

Objeto

Objeto de configurações de taxa de transferência provisionada do Cosmos DB

Nome	Tipo	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Política de atualização automática de recursos do Cosmos DB
maxThroughput	integer	Representa que o contêiner de taxa de transferência máxima pode ser escalado verticalmente.
targetMaxThroughput	integer	Representa que o contêiner de taxa de transferência máxima de destino pode ser dimensionado quando a oferta não estiver mais no estado pendente.

AutoUpgradePolicyResource

Objeto

Política de atualização automática de recursos do Cosmos DB

Nome	Tipo	Description
throughputPolicy	ThroughputPolicyResource	Representa a política de taxa de transferência à qual o serviço deve aderir para atualização automática

Resource

Objeto

Nome	Tipo	Description
_etag	string	Uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle de simultaneidade otimista.
_rid	string	Uma propriedade gerada pelo sistema. Um identificador exclusivo.
_ts	number	Uma propriedade gerada pelo sistema que indica o carimbo de data/hora atualizado da última vez do recurso.
autoscaleSettings	AutoscaleSettingsResource	Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o dimensionamento automático É necessário, mas não ambos.
instantMaximumThroughput	string	O valor da taxa de transferência da oferta para aumentar instantaneamente sem acionar divisões
minimumThroughput	string	A taxa de transferência mínima do recurso
offerReplacePending	string	A substituição da taxa de transferência está pendente
softAllowedMaximumThroughput	string	O valor máximo da taxa de transferência ou o valor máximo maxThroughput (para dimensionamento automático) que pode ser especificado
throughput	integer	Valor da taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático É necessário, mas não ambos.

ThroughputPolicyResource

Objeto

Política de taxa de transferência de recursos do Cosmos DB

Nome	Tipo	Description
incrementPercent	integer	Representa o percentual pelo qual a taxa de transferência pode aumentar a cada vez que a política de taxa de transferência é iniciada.
isEnabled	boolean	Determina se o ThroughputPolicy está ativo ou não

ThroughputSettingsGetResults

Objeto

Uma taxa de transferência de recursos do Azure Cosmos DB.

Nome	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso do ARM.
location	string	O local do grupo de recursos ao qual o recurso pertence.
name	string	O nome do recurso do ARM.
properties.resource	Resource
tags	object	As tags são uma lista de pares de chave-valor que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave não maior que 128 caracteres e o valor não seja maior que 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Tabela", "Gráfico", "Banco de Dados de Documentos" e "MongoDB".
type	string	O tipo de recurso do Azure.

ThroughputSettingsResource

Objeto

Objeto de taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático É necessário, mas não ambos.

Nome	Tipo	Description
autoscaleSettings	AutoscaleSettingsResource	Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o dimensionamento automático É necessário, mas não ambos.
instantMaximumThroughput	string	O valor da taxa de transferência da oferta para aumentar instantaneamente sem acionar divisões
minimumThroughput	string	A taxa de transferência mínima do recurso
offerReplacePending	string	A substituição da taxa de transferência está pendente
softAllowedMaximumThroughput	string	O valor máximo da taxa de transferência ou o valor máximo maxThroughput (para dimensionamento automático) que pode ser especificado
throughput	integer	Valor da taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático É necessário, mas não ambos.

ThroughputSettingsUpdateParameters

Objeto

As RUs por segundo dos parâmetros a serem fornecidos para a coleção atual do MongoDB.

Nome	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso do ARM.
location	string	O local do grupo de recursos ao qual o recurso pertence.
name	string	O nome do recurso do ARM.
properties.resource	ThroughputSettingsResource	O formato JSON padrão de uma taxa de transferência de recurso
tags	object	As tags são uma lista de pares de chave-valor que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave não maior que 128 caracteres e o valor não seja maior que 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Tabela", "Gráfico", "Banco de Dados de Documentos" e "MongoDB".
type	string	O tipo de recurso do Azure.