Mongo DB Resources - Update Mongo DB Collection Throughput

서비스:

Cosmos DB Resource Provider

API 버전:

2025-10-15

Azure Cosmos DB MongoDB 컬렉션의 초당 RU 업데이트

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 매개 변수

Name	In(다음 안에)	필수	형식	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 데이터베이스 계정 이름입니다.
collectionName	path	True	string	Cosmos DB 컬렉션 이름입니다.
databaseName	path	True	string	Cosmos DB 데이터베이스 이름입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string minLength: 1	대상 구독의 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
updateThroughputParameters	ThroughputSettingsUpdateParameters	현재 MongoDB 컬렉션에 제공할 매개 변수의 초당 RU입니다.

응답

Name	형식	Description
200 OK	ThroughputSettingsGetResults	MongoDB 컬렉션 업데이트 작업의 초당 RU가 성공적으로 완료되었습니다.
202 Accepted		MongoDB 컬렉션 업데이트 작업의 초당 RU는 비동기적으로 완료됩니다. 헤더 azure-AsyncOperation: string location: string

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

CosmosDBMongoDBCollectionThroughputUpdate

샘플 요청

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

샘플 응답

상태 코드:

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

상태 코드:

202

정의

Name	Description
AutoscaleSettingsResource	Cosmos DB 프로비전된 처리량 설정 개체
AutoUpgradePolicyResource	Cosmos DB 리소스 자동 업그레이드 정책
Resource
ThroughputPolicyResource	Cosmos DB 리소스 처리량 정책
ThroughputSettingsGetResults	Azure Cosmos DB 리소스 처리량입니다.
ThroughputSettingsResource	Cosmos DB 리소스 처리량 개체입니다. 처리량이 필요하거나 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.
ThroughputSettingsUpdateParameters	현재 MongoDB 컬렉션에 제공할 매개 변수의 초당 RU입니다.

AutoscaleSettingsResource

Object

Cosmos DB 프로비전된 처리량 설정 개체

Name	형식	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Cosmos DB 리소스 자동 업그레이드 정책
maxThroughput	integer	컨테이너가 확장할 수 있는 최대 처리량을 나타냅니다.
targetMaxThroughput	integer	제품이 더 이상 보류 중 상태가 아닌 경우 컨테이너가 확장할 수 있는 목표 최대 처리량을 나타냅니다.

AutoUpgradePolicyResource

Object

Cosmos DB 리소스 자동 업그레이드 정책

Name	형식	Description
throughputPolicy	ThroughputPolicyResource	서비스가 자동 업그레이드를 위해 준수해야 하는 처리량 정책을 나타냅니다.

Resource

Object

Name	형식	Description
_etag	string	낙관적 동시성 제어에 필요한 리소스 etag를 나타내는 시스템 생성 속성입니다.
_rid	string	시스템 생성 속성입니다. 고유 식별자입니다.
_ts	number	자원의 마지막으로 업데이트된 시간소인을 나타내는 시스템 생성 특성입니다.
autoscaleSettings	AutoscaleSettingsResource	자동 크기 조정 설정에 대한 Cosmos DB 리소스입니다. 처리량이 필요하거나 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.
instantMaximumThroughput	string	분할을 트리거하지 않고 즉시 확장할 수 있는 처리량 값을 제공합니다.
minimumThroughput	string	리소스의 최소 처리량
offerReplacePending	string	처리량 교체가 보류 중입니다.
softAllowedMaximumThroughput	string	지정할 수 있는 최대 처리량 값 또는 최대 maxThroughput 값(자동 크기 조정의 경우)
throughput	integer	Cosmos DB 리소스 처리량의 값입니다. 처리량이 필요하거나 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.

ThroughputPolicyResource

Object

Cosmos DB 리소스 처리량 정책

Name	형식	Description
incrementPercent	integer	처리량 정책이 시작될 때마다 처리량이 증가할 수 있는 백분율을 나타냅니다.
isEnabled	boolean	ThroughputPolicy가 활성 상태인지 여부를 확인합니다.

ThroughputSettingsGetResults

Object

Azure Cosmos DB 리소스 처리량입니다.

Name	형식	Description
id	string	ARM 리소스의 고유한 리소스 식별자입니다.
location	string	리소스가 속한 리소스 그룹의 위치입니다.
name	string	ARM 리소스의 이름입니다.
properties.resource	Resource
tags	object	태그는 리소스를 설명하는 키-값 쌍 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 키가 128자 이하이고 값이 256자 이하여야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.
type	string	Azure 리소스의 유형입니다.

ThroughputSettingsResource

Object

Cosmos DB 리소스 처리량 개체입니다. 처리량이 필요하거나 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.

Name	형식	Description
autoscaleSettings	AutoscaleSettingsResource	자동 크기 조정 설정에 대한 Cosmos DB 리소스입니다. 처리량이 필요하거나 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.
instantMaximumThroughput	string	분할을 트리거하지 않고 즉시 확장할 수 있는 처리량 값을 제공합니다.
minimumThroughput	string	리소스의 최소 처리량
offerReplacePending	string	처리량 교체가 보류 중입니다.
softAllowedMaximumThroughput	string	지정할 수 있는 최대 처리량 값 또는 최대 maxThroughput 값(자동 크기 조정의 경우)
throughput	integer	Cosmos DB 리소스 처리량의 값입니다. 처리량이 필요하거나 autoscaleSettings가 필요하지만 둘 다 필요하지는 않습니다.

ThroughputSettingsUpdateParameters

Object

현재 MongoDB 컬렉션에 제공할 매개 변수의 초당 RU입니다.

Name	형식	Description
id	string	ARM 리소스의 고유한 리소스 식별자입니다.
location	string	리소스가 속한 리소스 그룹의 위치입니다.
name	string	ARM 리소스의 이름입니다.
properties.resource	ThroughputSettingsResource	리소스 처리량의 표준 JSON 형식
tags	object	태그는 리소스를 설명하는 키-값 쌍 목록입니다. 이러한 태그는 리소스 그룹 전체에서 이 리소스를 보고 그룹화할 때 사용할 수 있습니다. 리소스에 대해 최대 15개의 태그를 제공할 수 있습니다. 각 태그에는 키가 128자 이하이고 값이 256자 이하여야 합니다. 예를 들어 템플릿 형식의 기본 환경은 "defaultExperience": "Cassandra"로 설정됩니다. 현재 "defaultExperience" 값에는 "Table", "Graph", "DocumentDB" 및 "MongoDB"도 포함됩니다.
type	string	Azure 리소스의 유형입니다.