Table Resources - Migrate Table To Autoscale

Service:

Cosmos DB Resource Provider

API-versie:

2025-10-15

Een Azure Cosmos DB-tabel migreren van handmatige doorvoer naar automatisch schalen

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Accountnaam van de Cosmos DB-database.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string minLength: 1	De id van het doelabonnement.
tableName	path	True	string	Cosmos DB tabelnaam.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ThroughputSettingsGetResults	De bewerking Tabelmigratie is voltooid.
202 Accepted		De bewerking Tabelmigratie wordt asynchroon voltooid. Kopteksten azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CosmosDBTableMigrateToAutoscale

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Statuscode:

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

Definities

Name	Description
AutoscaleSettingsResource	Object met instellingen voor door Cosmos DB ingerichte doorvoer
AutoUpgradePolicyResource	Beleid voor automatische upgrade van Cosmos DB-resources
CloudError	Een foutreactie van de service.
ErrorResponse	Reactie op fout.
Resource
ThroughputPolicyResource	Beleid voor doorvoer van Cosmos DB-resources
ThroughputSettingsGetResults	Een doorvoer van Azure Cosmos DB-resources.

AutoscaleSettingsResource

Object

Object met instellingen voor door Cosmos DB ingerichte doorvoer

Name	Type	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Beleid voor automatische upgrade van Cosmos DB-resources
maxThroughput	integer	Vertegenwoordigt de maximale doorvoercontainer die omhoog kan worden geschaald.
targetMaxThroughput	integer	Vertegenwoordigt het doel van de maximale doorvoer waartoe de container kan worden opgeschaald zodra de aanbieding niet meer in behandeling is.

AutoUpgradePolicyResource

Object

Beleid voor automatische upgrade van Cosmos DB-resources

Name	Type	Description
throughputPolicy	ThroughputPolicyResource	Vertegenwoordigt doorvoerbeleid waaraan de service moet voldoen voor automatische upgrade

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	ErrorResponse	Reactie op fout.

ErrorResponse

Object

Reactie op fout.

Name	Type	Description
code	string	Foutcode.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

Resource

Object

Name	Type	Description
_etag	string	Een door het systeem gegenereerde eigenschap die de resource-etag vertegenwoordigt die nodig is voor optimistische gelijktijdigheidscontrole.
_rid	string	Een door het systeem gegenereerde eigenschap. Een unieke identificatiecode.
_ts	number	Een door het systeem gegenereerde eigenschap die de laatst bijgewerkte tijdstempel van de resource aangeeft.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-resource voor instellingen voor automatisch schalen. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide.
instantMaximumThroughput	string	De bieden doorvoerwaarde om direct op te schalen zonder splitsingen te triggeren
minimumThroughput	string	De minimale doorvoer van de resource
offerReplacePending	string	De vervanging van de doorvoer is in afwachting
softAllowedMaximumThroughput	string	De maximale doorvoerwaarde of de maximale maxThroughput-waarde (voor automatisch schalen) die kan worden opgegeven
throughput	integer	Waarde van de doorvoer van cosmos DB-resources. Doorvoer is vereist of autoscaleSettings is vereist, maar niet beide.

ThroughputPolicyResource

Object

Beleid voor doorvoer van Cosmos DB-resources

Name	Type	Description
incrementPercent	integer	Vertegenwoordigt het percentage waarmee doorvoer kan toenemen telkens wanneer het doorvoerbeleid wordt geactiveerd.
isEnabled	boolean	Bepaalt of doorvoerbeleid actief is of niet

ThroughputSettingsGetResults

Object

Een doorvoer van Azure Cosmos DB-resources.

Name	Type	Description
id	string	De unieke resource-id van de ARM-resource.
location	string	De locatie van de resourcegroep waartoe de resource behoort.
name	string	De naam van de ARM-bron.
properties.resource	Resource
tags	object	Tags zijn een lijst met sleutel-waardeparen die de bron beschrijven. Deze tags kunnen worden gebruikt voor het weergeven en groeperen van deze resource (tussen resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben van maximaal 128 tekens en een waarde van maximaal 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. De huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.
type	string	Het type Azure-resource.