Table Resources - Migrate Table To Autoscale

Serviço:

Cosmos DB Resource Provider

Versão da API:

2025-04-15

Migrar uma tabela do Azure Cosmos DB da taxa de transferência manual para o dimensionamento automático

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome da conta de banco de dados do Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
tableName	path	True	string	Nome da tabela do Cosmos DB.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ThroughputSettingsGetResults	A operação de migração de tabela foi concluída com êxito.
202 Accepted		A operação de migração de tabela será concluída de forma assíncrona. Cabeçalhos azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	Assumir a identidade da sua conta de usuário

Exemplos

CosmosDBTableMigrateToAutoscale

Solicitação de exemplo

HTTP

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

Java

/**
 * Samples for TableResources MigrateTableToAutoscale.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-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/stable/2025-04-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/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-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/stable/2025-04-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

Resposta de exemplo

Código de status:

200

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

Código de 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-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

Definições

Nome	Description
AutoscaleSettingsResource	Objeto de configurações de taxa de transferência provisionada do Cosmos DB
AutoUpgradePolicyResource	Política de atualização automática de recursos do Cosmos DB
CloudError	Uma resposta de erro do serviço.
ErrorResponse	Resposta de erro.
Resource
ThroughputPolicyResource	Política de taxa de transferência de recursos do Cosmos DB
ThroughputSettingsGetResults	Uma taxa de transferência de recursos do Azure Cosmos DB.

AutoscaleSettingsResource

Objeto

Objeto de configurações de taxa de transferência provisionada do Cosmos DB

Nome	Tipo	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Política de atualização automática de recursos do Cosmos DB
maxThroughput	integer	Representa que o contêiner de taxa de transferência máxima pode ser escalado verticalmente.
targetMaxThroughput	integer	Representa que o contêiner de taxa de transferência máxima de destino pode ser escalado verticalmente até que a oferta não esteja mais em estado pendente.

AutoUpgradePolicyResource

Objeto

Política de atualização automática de recursos do Cosmos DB

Nome	Tipo	Description
throughputPolicy	ThroughputPolicyResource	Representa a política de taxa de transferência à qual o serviço deve aderir para atualização automática

CloudError

Objeto

Uma resposta de erro do serviço.

Nome	Tipo	Description
error	ErrorResponse	Resposta de erro.

ErrorResponse

Objeto

Resposta de erro.

Nome	Tipo	Description
code	string	Código de erro.
message	string	Mensagem de erro indicando por que a operação falhou.

Resource

Objeto

Nome	Tipo	Description
_etag	string	Uma propriedade gerada pelo sistema que representa a etag de recurso necessária para o controle de simultaneidade otimista.
_rid	string	Uma propriedade gerada pelo sistema. Um identificador exclusivo.
_ts	number	Uma propriedade gerada pelo sistema que indica o último carimbo de data/hora atualizado do recurso.
autoscaleSettings	AutoscaleSettingsResource	Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o dimensionamento automático É necessário, mas não ambos.
instantMaximumThroughput	string	O valor da taxa de transferência da oferta para escalar verticalmente instantaneamente sem disparar divisões
minimumThroughput	string	A taxa de transferência mínima do recurso
offerReplacePending	string	A substituição de taxa de transferência está pendente
softAllowedMaximumThroughput	string	O valor máximo da taxa de transferência ou o valor máximo de maxThroughput (para dimensionamento automático) que pode ser especificado
throughput	integer	Valor da taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o dimensionamento automático É necessário, mas não ambos.

ThroughputPolicyResource

Objeto

Política de taxa de transferência de recursos do Cosmos DB

Nome	Tipo	Description
incrementPercent	integer	Representa o percentual pelo qual a taxa de transferência pode aumentar a cada vez que a política de taxa de transferência é iniciada.
isEnabled	boolean	Determina se o ThroughputPolicy está ativo ou não

ThroughputSettingsGetResults

Objeto

Uma taxa de transferência de recursos do Azure Cosmos DB.

Nome	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso do ARM.
location	string	The location of the resource group to which the resource belongs.
name	string	O nome do recurso do ARM.
properties.resource	Resource
tags	object	As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas na exibição e agrupamento desse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave não maior que 128 caracteres e o valor não seja maior que 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB".
type	string	O tipo de recurso do Azure.