Sql Resources - Update Sql Container Throughput

服务:

Cosmos DB Resource Provider

API 版本:

2025-04-15

更新 Azure Cosmos DB SQL 容器每秒 RU 数

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default?api-version=2025-04-15

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 数据库帐户名称。
containerName	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 版本。

请求正文

名称	类型	说明
updateThroughputParameters	ThroughputSettingsUpdateParameters	要为当前 SQL 容器每秒 RU 提供的参数。

响应

名称	类型	说明
200 OK	ThroughputSettingsGetResults	SQL 容器更新操作每秒的 RU 已成功完成。
202 Accepted		SQL 容器更新操作的每秒 RU 将异步完成。 标头 azure-AsyncOperation: string location: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟您的用户账户

示例

CosmosDBSqlContainerThroughputUpdate

示例请求

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName/throughputSettings/default?api-version=2025-04-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 SqlResources UpdateSqlContainerThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBSqlContainerThroughputUpdate.json
     */
    /**
     * Sample code: CosmosDBSqlContainerThroughputUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBSqlContainerThroughputUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getSqlResources().updateSqlContainerThroughput("rg1", "ddb1",
            "databaseName", "containerName", 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_sql_container_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.sql_resources.begin_update_sql_container_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
        container_name="containerName",
        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/stable/2025-04-15/examples/CosmosDBSqlContainerThroughputUpdate.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/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBSqlContainerThroughputUpdate.json
func ExampleSQLResourcesClient_BeginUpdateSQLContainerThroughput() {
	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.NewSQLResourcesClient().BeginUpdateSQLContainerThroughput(ctx, "rg1", "ddb1", "databaseName", "containerName", 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/sqlDatabases/sqlContainers/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/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 RUs per second of an Azure Cosmos DB SQL container
 *
 * @summary Update RUs per second of an Azure Cosmos DB SQL container
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBSqlContainerThroughputUpdate.json
 */
async function cosmosDbSqlContainerThroughputUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const containerName = "containerName";
  const updateThroughputParameters = {
    location: "West US",
    resource: { throughput: 400 },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.sqlResources.beginUpdateSqlContainerThroughputAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    containerName,
    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

示例响应

状态代码:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/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 预配的吞吐量设置对象
AutoUpgradePolicyResource	Cosmos DB 资源自动升级策略
Resource
ThroughputPolicyResource	Cosmos DB 资源吞吐量策略
ThroughputSettingsGetResults	Azure Cosmos DB 资源吞吐量。
ThroughputSettingsResource	Cosmos DB 资源吞吐量对象。 需要吞吐量或自动缩放设置是必需的，但不需要两者。
ThroughputSettingsUpdateParameters	要为当前 SQL 容器每秒 RU 提供的参数。

AutoscaleSettingsResource

Object

Cosmos DB 预配的吞吐量设置对象

名称	类型	说明
autoUpgradePolicy	AutoUpgradePolicyResource	Cosmos DB 资源自动升级策略
maxThroughput	integer	表示最大吞吐量容器可以纵向扩展。
targetMaxThroughput	integer	表示目标最大吞吐量容器可以在产品/服务不再处于挂起状态后纵向扩展。

AutoUpgradePolicyResource

Object

Cosmos DB 资源自动升级策略

名称	类型	说明
throughputPolicy	ThroughputPolicyResource	表示服务必须遵循的吞吐量策略，以便自动升级

Resource

Object

名称	类型	说明
_etag	string	表示乐观并发控制所需的资源 etag 的系统生成属性。
_rid	string	系统生成的属性。 唯一标识符。
_ts	number	一个系统生成的属性，该属性表示资源的上次更新时间戳。
autoscaleSettings	AutoscaleSettingsResource	用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量或自动缩放设置是必需的，但不需要两者。
instantMaximumThroughput	string	提供吞吐量值，无需触发拆分即可立即纵向扩展
minimumThroughput	string	资源的最低吞吐量
offerReplacePending	string	吞吐量替换处于挂起状态
softAllowedMaximumThroughput	string	可以指定的最大吞吐量值或最大 maxThroughput 值（对于自动缩放）
throughput	integer	Cosmos DB 资源吞吐量的值。 需要吞吐量或自动缩放设置是必需的，但不需要两者。

ThroughputPolicyResource

Object

Cosmos DB 资源吞吐量策略

名称	类型	说明
incrementPercent	integer	表示每次启动吞吐量策略时吞吐量可能会增加的百分比。
isEnabled	boolean	确定 ThroughputPolicy 是否处于活动状态

ThroughputSettingsGetResults

Object

Azure Cosmos DB 资源吞吐量。

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
location	string	The location of the resource group to which the resource belongs.
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	AutoscaleSettingsResource	用于自动缩放设置的 Cosmos DB 资源。 需要吞吐量或自动缩放设置是必需的，但不需要两者。
instantMaximumThroughput	string	提供吞吐量值，无需触发拆分即可立即纵向扩展
minimumThroughput	string	资源的最低吞吐量
offerReplacePending	string	吞吐量替换处于挂起状态
softAllowedMaximumThroughput	string	可以指定的最大吞吐量值或最大 maxThroughput 值（对于自动缩放）
throughput	integer	Cosmos DB 资源吞吐量的值。 需要吞吐量或自动缩放设置是必需的，但不需要两者。

ThroughputSettingsUpdateParameters

Object

要为当前 SQL 容器每秒 RU 提供的参数。

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
location	string	The location of the resource group to which the resource belongs.
name	string	ARM 资源的名称。
properties.resource	ThroughputSettingsResource	资源吞吐量的标准 JSON 格式
tags	object	标记是描述资源的键值对的列表。 这些标记可用于查看和分组此资源（跨资源组）。 最多可为资源提供 15 个标记。 每个标记必须具有不超过 128 个字符的键，且值不超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
type	string	Azure 资源的类型。