Mongo DB Resources - Update Mongo DB Collection Throughput

Hizmet:

Cosmos DB Resource Provider

API Sürümü:

2025-10-15

Azure Cosmos DB MongoDB koleksiyonunun saniye başına RU'larını güncelleştirme

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 Parametreleri

Name	İçinde	Gerekli	Tür	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB veritabanı hesap adı.
collectionName	path	True	string	Cosmos DB koleksiyon adı.
databaseName	path	True	string	Cosmos DB veritabanı adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
subscriptionId	path	True	string minLength: 1	Hedef aboneliğin kimliği.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
updateThroughputParameters	ThroughputSettingsUpdateParameters	Geçerli MongoDB koleksiyonunu sağlamak için parametrelerin saniye başına RU'ları.

Yanıtlar

Name	Tür	Description
200 OK	ThroughputSettingsGetResults	MongoDB koleksiyonu güncelleştirme işleminin saniye başına RU sayısı başarıyla tamamlandı.
202 Accepted		MongoDB koleksiyonu güncelleştirme işleminin saniye başına RU değerleri zaman uyumsuz olarak tamamlanır. Üst Bilgiler azure-AsyncOperation: string location: string

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	Kullanıcı hesabınızı taklit edin

Örnekler

CosmosDBMongoDBCollectionThroughputUpdate

Örnek isteği

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

Örnek yanıt

Durum kodu:

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

Durum kodu:

202

Tanımlar

Name	Description
AutoscaleSettingsResource	Cosmos DB tarafından sağlanan aktarım hızı ayarları nesnesi
AutoUpgradePolicyResource	Cosmos DB kaynak otomatik yükseltme ilkesi
Resource
ThroughputPolicyResource	Cosmos DB kaynak aktarım hızı ilkesi
ThroughputSettingsGetResults	Azure Cosmos DB kaynak aktarım hızı.
ThroughputSettingsResource	Cosmos DB kaynak aktarım hızı nesnesi. Aktarım hızı gereklidir veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir.
ThroughputSettingsUpdateParameters	Geçerli MongoDB koleksiyonunu sağlamak için parametrelerin saniye başına RU'ları.

AutoscaleSettingsResource

Nesne

Cosmos DB tarafından sağlanan aktarım hızı ayarları nesnesi

Name	Tür	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Cosmos DB kaynak otomatik yükseltme ilkesi
maxThroughput	integer	Ölçeği artırabilen en yüksek aktarım hızı kapsayıcısını temsil eder.
targetMaxThroughput	integer	Kapsayıcının ölçeğini teklif artık beklemede olmadığında artırabileceği hedef en yüksek aktarım hızını temsil eder.

AutoUpgradePolicyResource

Nesne

Cosmos DB kaynak otomatik yükseltme ilkesi

Name	Tür	Description
throughputPolicy	ThroughputPolicyResource	Otomatik yükseltme için hizmetin uyması gereken aktarım hızı ilkesini temsil eder

Resource

Nesne

Name	Tür	Description
_etag	string	İyimser eşzamanlılık denetimi için gereken kaynak etag'ini temsil eden sistem tarafından oluşturulan bir özellik.
_rid	string	Sistem tarafından oluşturulan bir özellik. Benzersiz bir tanımlayıcı.
_ts	number	Kaynağın son güncelleştirilen zaman damgasını gösteren, sistem tarafından oluşturulan bir özellik.
autoscaleSettings	AutoscaleSettingsResource	Otomatik ölçeklendirme ayarları için Cosmos DB kaynağı. Aktarım hızı gereklidir veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir.
instantMaximumThroughput	string	Bölünmeleri tetiklemeden anında ölçeklendirmek için teklif aktarım hızı değeri
minimumThroughput	string	Kaynağın en düşük aktarım hızı
offerReplacePending	string	Aktarım hızı değişimi beklemede
softAllowedMaximumThroughput	string	Belirtilebilen en yüksek aktarım hızı değeri veya en yüksek maxThroughput değeri (otomatik ölçeklendirme için)
throughput	integer	Cosmos DB kaynak aktarım hızının değeri. Aktarım hızı gereklidir veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir.

ThroughputPolicyResource

Nesne

Cosmos DB kaynak aktarım hızı ilkesi

Name	Tür	Description
incrementPercent	integer	Aktarım hızı ilkesi her başlatıldığında aktarım hızının artabileceği yüzdeyi temsil eder.
isEnabled	boolean	ThroughputPolicy'nin etkin olup olmadığını belirler

ThroughputSettingsGetResults

Nesne

Azure Cosmos DB kaynak aktarım hızı.

Name	Tür	Description
id	string	ARM kaynağının benzersiz kaynak tanımlayıcısı.
location	string	Kaynağın ait olduğu kaynak grubunun konumu.
name	string	ARM kaynağının adı.
properties.resource	Resource
tags	object	Etiketler, kaynağı tanımlayan anahtar/değer çiftlerinin listesidir. Bu etiketler, bu kaynağı görüntülemek ve gruplandırırken (kaynak grupları arasında) kullanılabilir. Bir kaynak için en fazla 15 etiket sağlanabilir. Her etiketin 128 karakterden büyük olmayan bir anahtarı ve 256 karakterden büyük olmayan bir değeri olmalıdır. Örneğin, bir şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri "Table", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir.
type	string	Azure kaynağının türü.

ThroughputSettingsResource

Nesne

Cosmos DB kaynak aktarım hızı nesnesi. Aktarım hızı gereklidir veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir.

Name	Tür	Description
autoscaleSettings	AutoscaleSettingsResource	Otomatik ölçeklendirme ayarları için Cosmos DB kaynağı. Aktarım hızı gereklidir veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir.
instantMaximumThroughput	string	Bölünmeleri tetiklemeden anında ölçeklendirmek için teklif aktarım hızı değeri
minimumThroughput	string	Kaynağın en düşük aktarım hızı
offerReplacePending	string	Aktarım hızı değişimi beklemede
softAllowedMaximumThroughput	string	Belirtilebilen en yüksek aktarım hızı değeri veya en yüksek maxThroughput değeri (otomatik ölçeklendirme için)
throughput	integer	Cosmos DB kaynak aktarım hızının değeri. Aktarım hızı gereklidir veya otomatik ölçeklendirmeAyarlar gereklidir, ancak her ikisi de gerekli değildir.

ThroughputSettingsUpdateParameters

Nesne

Geçerli MongoDB koleksiyonunu sağlamak için parametrelerin saniye başına RU'ları.

Name	Tür	Description
id	string	ARM kaynağının benzersiz kaynak tanımlayıcısı.
location	string	Kaynağın ait olduğu kaynak grubunun konumu.
name	string	ARM kaynağının adı.
properties.resource	ThroughputSettingsResource	Kaynak aktarım hızının standart JSON biçimi
tags	object	Etiketler, kaynağı tanımlayan anahtar/değer çiftlerinin listesidir. Bu etiketler, bu kaynağı görüntülemek ve gruplandırırken (kaynak grupları arasında) kullanılabilir. Bir kaynak için en fazla 15 etiket sağlanabilir. Her etiketin 128 karakterden büyük olmayan bir anahtarı ve 256 karakterden büyük olmayan bir değeri olmalıdır. Örneğin, bir şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri "Table", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir.
type	string	Azure kaynağının türü.