Mongo DB Resources - Update Mongo DB Collection Throughput

Служба:

Cosmos DB Resource Provider

Версия API:

2025-10-15

Обновление единиц запроса в секунду коллекции MongoDB 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

Параметры URI

Имя	В	Обязательно	Тип	Описание
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	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Тип	Описание
updateThroughputParameters	ThroughputSettingsUpdateParameters	Количество единиц запроса в секунду параметров, которые должны быть предоставлены для текущей коллекции MongoDB.

Ответы

Имя	Тип	Описание
200 OK	ThroughputSettingsGetResults	Количество единиц запроса в секунду операции обновления коллекции MongoDB выполнено успешно.
202 Accepted		Количество единиц запроса в секунду операции обновления коллекции MongoDB будет выполняться асинхронно. Заголовки azure-AsyncOperation: string location: string

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
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

Определения

Имя	Описание
AutoscaleSettingsResource	Cosmos DB Provisioned Throughput settings object
AutoUpgradePolicyResource	Политика автоматического обновления ресурсов Cosmos DB
Resource
ThroughputPolicyResource	Политика пропускной способности ресурсов Cosmos DB
ThroughputSettingsGetResults	Пропускная способность ресурсов Azure Cosmos DB.
ThroughputSettingsResource	Объект пропускной способности ресурсов Cosmos DB. Требуется либо пропускная способность, либо требуется автомасштабированиеSettings, но не оба.
ThroughputSettingsUpdateParameters	Количество единиц запроса в секунду параметров, которые должны быть предоставлены для текущей коллекции MongoDB.

AutoscaleSettingsResource

Объект

Cosmos DB Provisioned Throughput settings object

Имя	Тип	Описание
autoUpgradePolicy	AutoUpgradePolicyResource	Политика автоматического обновления ресурсов Cosmos DB
maxThroughput	integer	Представляет контейнер максимальной пропускной способности, который может масштабироваться до.
targetMaxThroughput	integer	Представляет целевую максимальную пропускную способность, контейнер может масштабироваться до тех пор, пока предложение больше не находится в состоянии ожидания.

AutoUpgradePolicyResource

Объект

Политика автоматического обновления ресурсов Cosmos DB

Имя	Тип	Описание
throughputPolicy	ThroughputPolicyResource	Представляет политику пропускной способности, которую служба должна придерживаться для автоматического обновления

Resource

Объект

Имя	Тип	Описание
_etag	string	Сгенерированное системой свойство, представляющее тег ресурса, необходимый для управления оптимистичным параллелизмом.
_rid	string	Свойство, созданное системой. Уникальный идентификатор.
_ts	number	Сгенерированное системой свойство, обозначающее последнюю обновленную метку времени ресурса.
autoscaleSettings	AutoscaleSettingsResource	Ресурс Cosmos DB для параметров автомасштабирования. Требуется либо пропускная способность, либо требуется автомасштабированиеSettings, но не оба.
instantMaximumThroughput	string	Значение пропускной способности предложения для мгновенного масштабирования без запуска разделений
minimumThroughput	string	Минимальная пропускная способность ресурса
offerReplacePending	string	Ожидается замена пропускной способности
softAllowedMaximumThroughput	string	Максимальное значение пропускной способности или максимальное значение maxThroughput (для автомасштабирования), которое можно указать
throughput	integer	Значение пропускной способности ресурсов Cosmos DB. Требуется либо пропускная способность, либо требуется автомасштабированиеSettings, но не оба.

ThroughputPolicyResource

Объект

Политика пропускной способности ресурсов Cosmos DB

Имя	Тип	Описание
incrementPercent	integer	Представляет процент, с помощью которого пропускная способность может увеличиваться при каждом запуске политики пропускной способности.
isEnabled	boolean	Определяет, является ли пропускная способность активной или нет

ThroughputSettingsGetResults

Объект

Пропускная способность ресурсов Azure Cosmos DB.

Имя	Тип	Описание
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

Объект

Объект пропускной способности ресурсов Cosmos DB. Требуется либо пропускная способность, либо требуется автомасштабированиеSettings, но не оба.

Имя	Тип	Описание
autoscaleSettings	AutoscaleSettingsResource	Ресурс Cosmos DB для параметров автомасштабирования. Требуется либо пропускная способность, либо требуется автомасштабированиеSettings, но не оба.
instantMaximumThroughput	string	Значение пропускной способности предложения для мгновенного масштабирования без запуска разделений
minimumThroughput	string	Минимальная пропускная способность ресурса
offerReplacePending	string	Ожидается замена пропускной способности
softAllowedMaximumThroughput	string	Максимальное значение пропускной способности или максимальное значение maxThroughput (для автомасштабирования), которое можно указать
throughput	integer	Значение пропускной способности ресурсов Cosmos DB. Требуется либо пропускная способность, либо требуется автомасштабированиеSettings, но не оба.

ThroughputSettingsUpdateParameters

Объект

Количество единиц запроса в секунду параметров, которые должны быть предоставлены для текущей коллекции MongoDB.

Имя	Тип	Описание
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.