Mongo DB Resources - Update Mongo DB Database Throughput

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Azure Cosmos DB MongoDB データベースの 1 秒あたりの RU の更新

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default?api-version=2023-11-15

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	Cosmos DB データベース アカウント名。 Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
databaseName	path	True	string	Cosmos DB データベース名。
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

名前	型	説明
updateThroughputParameters	ThroughputSettingsUpdateParameters	現在の MongoDB データベースに提供するパラメーターの 1 秒あたりの RU。

応答

名前	型	説明
200 OK	ThroughputSettingsGetResults	MongoDB データベース更新操作の 1 秒あたりの RU が正常に完了しました。
202 Accepted		MongoDB データベース更新操作の 1 秒あたりの RU は非同期的に完了します。 Headers azure-AsyncOperation: string location: string
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

CosmosDBMongoDBDatabaseThroughputUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default?api-version=2023-11-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 UpdateMongoDBDatabaseThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBMongoDBDatabaseThroughputUpdate.json
     */
    /**
     * Sample code: CosmosDBMongoDBDatabaseThroughputUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBDatabaseThroughputUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().updateMongoDBDatabaseThroughput(
            "rg1", "ddb1", "databaseName", 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_database_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_database_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
        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/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json
func ExampleMongoDBResourcesClient_BeginUpdateMongoDBDatabaseThroughput() {
	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().BeginUpdateMongoDBDatabaseThroughput(ctx, "rg1", "ddb1", "databaseName", 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/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/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");

/**
 * This sample demonstrates how to Update RUs per second of the an Azure Cosmos DB MongoDB database
 *
 * @summary Update RUs per second of the an Azure Cosmos DB MongoDB database
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json
 */
async function cosmosDbMongoDbdatabaseThroughputUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const updateThroughputParameters = {
    location: "West US",
    resource: { throughput: 400 },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.beginUpdateMongoDBDatabaseThroughputAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Status code:

202

定義

名前	説明
AutoscaleSettingsResource	Cosmos DB によってプロビジョニングされたスループット設定オブジェクト
AutoUpgradePolicyResource	Cosmos DB リソースの自動アップグレード ポリシー
CloudError	サービスからのエラー応答。
ErrorResponse	エラー応答。
Resource
ThroughputPolicyResource	Cosmos DB リソース スループット ポリシー
ThroughputSettingsGetResults	Azure Cosmos DB リソースのスループット。
ThroughputSettingsResource	Cosmos DB リソース スループット オブジェクト。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。
ThroughputSettingsUpdateParameters	現在の MongoDB データベースに提供するパラメーターの 1 秒あたりの RU。

AutoscaleSettingsResource

Cosmos DB によってプロビジョニングされたスループット設定オブジェクト

名前	型	説明
autoUpgradePolicy	AutoUpgradePolicyResource	Cosmos DB リソースの自動アップグレード ポリシー
maxThroughput	integer	スケールアップできる最大スループット コンテナーを表します。
targetMaxThroughput	integer	オファーが保留中の状態でなくなったら、コンテナーがスケールアップできるターゲットの最大スループット コンテナーを表します。

AutoUpgradePolicyResource

Cosmos DB リソースの自動アップグレード ポリシー

名前	型	説明
throughputPolicy	ThroughputPolicyResource	自動アップグレードのためにどのサービスに準拠する必要があるスループット ポリシーを表します

CloudError

サービスからのエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答。

ErrorResponse

エラー応答。

名前	型	説明
code	string	エラー コード。
message	string	操作が失敗した理由を示すエラー メッセージ。

Resource

名前	型	説明
_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

Cosmos DB リソース スループット ポリシー

名前	型	説明
incrementPercent	integer	スループット ポリシーが開始されるたびにスループットが増加する割合を表します。
isEnabled	boolean	ThroughputPolicy がアクティブかどうかを判断します

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 リソース スループット オブジェクト。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。

名前	型	説明
autoscaleSettings	AutoscaleSettingsResource	自動スケーリング設定用の Cosmos DB リソース。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。
instantMaximumThroughput	string	分割をトリガーせずに瞬時にスケールアップするためのオファー スループット値
minimumThroughput	string	リソースの最小スループット
offerReplacePending	string	スループットの置き換えが保留中です
softAllowedMaximumThroughput	string	指定できる最大スループット値または最大 maxThroughput 値 (自動スケーリングの場合)
throughput	integer	Cosmos DB リソースのスループットの値。 スループットが必要か、autoscaleSettings が必要ですが、両方は必要ありません。

ThroughputSettingsUpdateParameters

現在の MongoDB データベースに提供するパラメーターの 1 秒あたりの RU。

名前	型	説明
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 リソースの種類。