Mongo DB Resources - Migrate Mongo DB Database To Autoscale

Hizmet:

Cosmos DB Resource Provider

API Sürümü:

2025-04-15

Azure Cosmos DB MongoDB veritabanını el ile aktarım hızından otomatik ölçeklendirmeye geçirme

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale?api-version=2025-04-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ı.
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ü.

Yanıtlar

Name	Tür	Description
200 OK	ThroughputSettingsGetResults	MongoDB veritabanı geçirme işlemi başarıyla tamamlandı.
202 Accepted		MongoDB veritabanı geçirme işlemi zaman uyumsuz olarak tamamlanır. Üst Bilgiler azure-AsyncOperation: string location: string
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

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

CosmosDBMongoDBDatabaseMigrateToAutoscale

Örnek isteği

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default/migrateToAutoscale?api-version=2025-04-15

Java

/**
 * Samples for MongoDBResources MigrateMongoDBDatabaseToAutoscale.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBMongoDBDatabaseMigrateToAutoscale.json
     */
    /**
     * Sample code: CosmosDBMongoDBDatabaseMigrateToAutoscale.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBDatabaseMigrateToAutoscale(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources()
            .migrateMongoDBDatabaseToAutoscale("rg1", "ddb1", "databaseName", com.azure.core.util.Context.NONE);
    }
}

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_migrate_to_autoscale.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_migrate_mongo_db_database_to_autoscale(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.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/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/CosmosDBMongoDBDatabaseMigrateToAutoscale.json
func ExampleMongoDBResourcesClient_BeginMigrateMongoDBDatabaseToAutoscale() {
	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().BeginMigrateMongoDBDatabaseToAutoscale(ctx, "rg1", "ddb1", "databaseName", 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{
	// 	Properties: &armcosmos.ThroughputSettingsGetProperties{
	// 		Resource: &armcosmos.ThroughputSettingsGetPropertiesResource{
	// 			Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
	// 			Rid: to.Ptr("PD5DALigDgw="),
	// 			Ts: to.Ptr[float32](1459200611),
	// 			AutoscaleSettings: &armcosmos.AutoscaleSettingsResource{
	// 				MaxThroughput: to.Ptr[int32](4000),
	// 			},
	// 			MinimumThroughput: to.Ptr("4000"),
	// 			OfferReplacePending: to.Ptr("false"),
	// 			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 Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale
 *
 * @summary Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json
 */
async function cosmosDbMongoDbdatabaseMigrateToAutoscale() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.beginMigrateMongoDBDatabaseToAutoscaleAndWait(
    resourceGroupName,
    accountName,
    databaseName,
  );
  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

Örnek yanıt

Durum kodu:

200

{
  "properties": {
    "resource": {
      "throughput": 400,
      "autoscaleSettings": {
        "maxThroughput": 4000
      },
      "minimumThroughput": "4000",
      "offerReplacePending": "false",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

Durum kodu:

202

Location: https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2025-04-15
Azure-AsyncOperation: https://centraluseuap.management.azure.com/subscriptions/d1eb41bc-1b7f-4404-bd2a-8568c222852d/providers/Microsoft.DocumentDB/locations/centraluseuap/operationsStatus/fdd04b7b-86d5-460f-b19e-386230348bcc?api-version=2025-04-15

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
CloudError	Hizmetten bir hata yanıtı.
ErrorResponse	Hata Yanıtı.
Resource
ThroughputPolicyResource	Cosmos DB kaynak aktarım hızı ilkesi
ThroughputSettingsGetResults	Azure Cosmos DB kaynak aktarım hızı.

AutoscaleSettingsResource

Object

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	Hedef maksimum aktarım hızı kapsayıcısı, teklif artık bekleme durumunda olmadığında ölçeği artırabilir.

AutoUpgradePolicyResource

Object

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

CloudError

Object

Hizmetten bir hata yanıtı.

Name	Tür	Description
error	ErrorResponse	Hata Yanıtı.

ErrorResponse

Object

Hata Yanıtı.

Name	Tür	Description
code	string	Hata kodu.
message	string	İşlemin neden başarısız olduğunu gösteren hata iletisi.

Resource

Object

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 özellik.
_rid	string	Sistem tarafından oluşturulan bir özellik. Benzersiz bir tanımlayıcı.
_ts	number	Kaynağın son güncelleştirilmiş zaman damgasını belirten 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ölmeleri tetiklemeden ölçeği anında artırmaya yönelik 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ştirme bekliyor
softAllowedMaximumThroughput	string	Belirtilebilen maksimum aktarım hızı değeri veya maksimum 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

Object

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

Object

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	The location of the resource group to which the resource belongs.
name	string	ARM kaynağının adı.
properties.resource	Resource
tags	object	Etiketler, kaynağı açıklayan 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, şablon türü için varsayılan deneyim "defaultExperience": "Cassandra" ile ayarlanır. Geçerli "defaultExperience" değerleri ayrıca "Table", "Graph", "DocumentDB" ve "MongoDB" değerlerini de içerir.
type	string	Azure kaynağının türü.