Table Resources - Migrate Table To Autoscale

Tjänst:

Cosmos DB Resource Provider

API-versionen:

2025-10-15

Migrera en Azure Cosmos DB-tabell från manuellt dataflöde till autoskalning

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-parametrar

Namn	I	Krävs	Typ	Beskrivning
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Namn på Cosmos DB-databaskonto.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string minLength: 1	ID för målprenumerationen.
tableName	path	True	string	Namn på Cosmos DB-tabell.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svaren

Namn	Typ	Beskrivning
200 OK	ThroughputSettingsGetResults	Tabellmigreringsåtgärden har slutförts.
202 Accepted		Tabellmigreringsåtgärden slutförs asynkront. Headers azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	Personifiera ditt användarkonto

Exempel

CosmosDBTableMigrateToAutoscale

Exempelförfrågan

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

Exempelsvar

Statuskod:

200

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

Statuskod:

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

Definitioner

Namn	Beskrivning
AutoscaleSettingsResource	Cosmos DB objekt för etablerade dataflödesinställningar
AutoUpgradePolicyResource	Princip för automatisk uppgradering av Cosmos DB-resurser
CloudError	Ett felsvar från tjänsten.
ErrorResponse	Svar på ett fel.
Resource
ThroughputPolicyResource	Princip för Cosmos DB-resursdataflöde
ThroughputSettingsGetResults	Ett dataflöde för Azure Cosmos DB-resursen.

AutoscaleSettingsResource

Objekt

Cosmos DB objekt för etablerade dataflödesinställningar

Namn	Typ	Beskrivning
autoUpgradePolicy	AutoUpgradePolicyResource	Princip för automatisk uppgradering av Cosmos DB-resurser
maxThroughput	integer	Representerar maximalt dataflöde som containern kan skala upp till.
targetMaxThroughput	integer	Representerar det maximala dataflöde som containern kan skalas upp till när erbjudandet inte längre är i väntande tillstånd.

AutoUpgradePolicyResource

Objekt

Princip för automatisk uppgradering av Cosmos DB-resurser

Namn	Typ	Beskrivning
throughputPolicy	ThroughputPolicyResource	Representerar den dataflödesprincip som tjänsten måste följa för automatisk uppgradering

CloudError

Objekt

Ett felsvar från tjänsten.

Namn	Typ	Beskrivning
error	ErrorResponse	Svar på ett fel.

ErrorResponse

Objekt

Svar på ett fel.

Namn	Typ	Beskrivning
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

Resource

Objekt

Namn	Typ	Beskrivning
_etag	string	En systemgenererad egenskap som representerar den resurstagg som krävs för optimistisk samtidighetskontroll.
_rid	string	En systemgenererad egenskap. En unik identifierare.
_ts	number	En systemgenererad egenskap som anger den senast uppdaterade tidsstämpeln för resursen.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-resurs för autoskalningsinställningar. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.
instantMaximumThroughput	string	Erbjudandets dataflödesvärde för att omedelbart skala upp utan att utlösa delningar
minimumThroughput	string	Minsta dataflöde för resursen
offerReplacePending	string	Ersättandet av dataflödet väntar
softAllowedMaximumThroughput	string	Det maximala dataflödesvärdet eller det maximala maxThroughput-värdet (för autoskalning) som kan anges
throughput	integer	Värdet för Cosmos DB-resursens dataflöde. Antingen krävs dataflöde eller autoscaleSettings, men inte båda.

ThroughputPolicyResource

Objekt

Princip för Cosmos DB-resursdataflöde

Namn	Typ	Beskrivning
incrementPercent	integer	Representerar den procentandel med vilken dataflödet kan öka varje gång dataflödesprincipen startar.
isEnabled	boolean	Avgör om ThroughputPolicy är aktiv eller inte

ThroughputSettingsGetResults

Objekt

Ett dataflöde för Azure Cosmos DB-resursen.

Namn	Typ	Beskrivning
id	string	Den unika resursidentifieraren för ARM-resursen.
location	string	Platsen för den resursgrupp som resursen tillhör.
name	string	Namnet på ARM-resursen.
properties.resource	Resource
tags	object	Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".
type	string	Typ av Azure-resurs.