Table Resources - Migrate Table To Autoscale

Layanan:

Cosmos DB Resource Provider

Versi API:

2025-10-15

Memigrasikan Tabel Azure Cosmos DB dari throughput manual ke skala otomatis

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale?api-version=2025-10-15

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nama akun database Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
tableName	path	True	string	Nama tabel Cosmos DB.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ThroughputSettingsGetResults	Operasi migrasi tabel berhasil diselesaikan.
202 Accepted		Operasi migrasi tabel akan selesai secara asinkron. Header azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

CosmosDBTableMigrateToAutoscale

Permintaan sampel

HTTP

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

Java

/**
 * Samples for TableResources MigrateTableToAutoscale.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/
     * CosmosDBTableMigrateToAutoscale.json
     */
    /**
     * Sample code: CosmosDBTableMigrateToAutoscale.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBTableMigrateToAutoscale(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getTableResources().migrateTableToAutoscale("rg1", "ddb1",
            "tableName", 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_table_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.table_resources.begin_migrate_table_to_autoscale(
        resource_group_name="rg1",
        account_name="ddb1",
        table_name="tableName",
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBTableMigrateToAutoscale.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/8b53f9cfc1fdb24dbfa28e311d3be4c645169297/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBTableMigrateToAutoscale.json
func ExampleTableResourcesClient_BeginMigrateTableToAutoscale() {
	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.NewTableResourcesClient().BeginMigrateTableToAutoscale(ctx, "rg1", "ddb1", "tableName", 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 Table from manual throughput to autoscale
 *
 * @summary Migrate an Azure Cosmos DB Table from manual throughput to autoscale
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/DocumentDB/stable/2025-10-15/examples/CosmosDBTableMigrateToAutoscale.json
 */
async function cosmosDbTableMigrateToAutoscale() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const tableName = "tableName";
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.tableResources.beginMigrateTableToAutoscaleAndWait(
    resourceGroupName,
    accountName,
    tableName,
  );
  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/CosmosDBTableMigrateToAutoscale.json
// this example is just showing the usage of "TableResources_MigrateTableToAutoscale" 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 CosmosTableThroughputSettingResource created on azure
// for more information of creating CosmosTableThroughputSettingResource, please refer to the document of CosmosTableThroughputSettingResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string accountName = "ddb1";
string tableName = "tableName";
ResourceIdentifier cosmosTableThroughputSettingResourceId = CosmosTableThroughputSettingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, tableName);
CosmosTableThroughputSettingResource cosmosTableThroughputSetting = client.GetCosmosTableThroughputSettingResource(cosmosTableThroughputSettingResourceId);

// invoke the operation
ArmOperation<CosmosTableThroughputSettingResource> lro = await cosmosTableThroughputSetting.MigrateTableToAutoscaleAsync(WaitUntil.Completed);
CosmosTableThroughputSettingResource 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

Respon sampel

Kode status:

200

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

Kode status:

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-10-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-10-15

Definisi

Nama	Deskripsi
AutoscaleSettingsResource	Objek pengaturan throughput yang disediakan Cosmos DB
AutoUpgradePolicyResource	Kebijakan peningkatan otomatis sumber daya Cosmos DB
CloudError	Respons kesalahan dari layanan.
ErrorResponse	Respons Kesalahan.
Resource
ThroughputPolicyResource	Kebijakan throughput sumber daya Cosmos DB
ThroughputSettingsGetResults	Throughput sumber daya Azure Cosmos DB.

AutoscaleSettingsResource

Objek

Objek pengaturan throughput yang disediakan Cosmos DB

Nama	Jenis	Deskripsi
autoUpgradePolicy	AutoUpgradePolicyResource	Kebijakan peningkatan otomatis sumber daya Cosmos DB
maxThroughput	integer	Mewakili kontainer throughput maksimum yang dapat ditingkatkan skalanya.
targetMaxThroughput	integer	Mewakili kontainer throughput maksimum target yang dapat diskalakan setelah penawaran tidak lagi dalam status tertunda.

AutoUpgradePolicyResource

Objek

Kebijakan peningkatan otomatis sumber daya Cosmos DB

Nama	Jenis	Deskripsi
throughputPolicy	ThroughputPolicyResource	Mewakili kebijakan throughput yang harus dipatuhi layanan untuk peningkatan otomatis

CloudError

Objek

Respons kesalahan dari layanan.

Nama	Jenis	Deskripsi
error	ErrorResponse	Respons Kesalahan.

ErrorResponse

Objek

Respons Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

Resource

Objek

Nama	Jenis	Deskripsi
_etag	string	Properti yang dihasilkan sistem yang mewakili etag sumber daya yang diperlukan untuk kontrol konkurensi yang optimis.
_rid	string	Properti yang dihasilkan sistem. Pengidentifikasi unik.
_ts	number	Properti yang dihasilkan sistem yang menunjukkan stempel waktu sumber daya yang terakhir diperbarui.
autoscaleSettings	AutoscaleSettingsResource	Sumber daya Cosmos DB untuk pengaturan skala otomatis. Throughput diperlukan atau autoscaleSettings diperlukan, tetapi tidak keduanya.
instantMaximumThroughput	string	Nilai throughput penawaran untuk langsung meningkatkan skala tanpa memicu pemisahan
minimumThroughput	string	Throughput minimum sumber daya
offerReplacePending	string	Penggantian throughput tertunda
softAllowedMaximumThroughput	string	Nilai throughput maksimum atau nilai maxThroughput maksimum (untuk skala otomatis) yang dapat ditentukan
throughput	integer	Nilai throughput sumber daya Cosmos DB. Throughput diperlukan atau autoscaleSettings diperlukan, tetapi tidak keduanya.

ThroughputPolicyResource

Objek

Kebijakan throughput sumber daya Cosmos DB

Nama	Jenis	Deskripsi
incrementPercent	integer	Mewakili persentase di mana throughput dapat meningkat setiap kali kebijakan throughput dimulai.
isEnabled	boolean	Menentukan apakah ThroughputPolicy aktif atau tidak

ThroughputSettingsGetResults

Objek

Throughput sumber daya Azure Cosmos DB.

Nama	Jenis	Deskripsi
id	string	Pengidentifikasi sumber daya unik dari sumber daya ARM.
location	string	Lokasi grup sumber daya tempat sumber daya berada.
name	string	Nama sumber daya ARM.
properties.resource	Resource
tags	object	Tag adalah daftar pasangan kunci-nilai yang mendeskripsikan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".
type	string	Jenis sumber daya Azure.