Table Resources - Update Table Throughput

Servicio:

Cosmos DB Resource Provider

Versión de la API:

2025-04-15

Actualización de RU por segundo de una tabla de Azure Cosmos DB

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nombre de la cuenta de base de datos de Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
tableName	path	True	string	Nombre de la tabla de Cosmos DB.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
updateThroughputParameters	ThroughputSettingsUpdateParameters	Parámetros que se van a proporcionar para las RU por segundo de la tabla actual.

Respuestas

Nombre	Tipo	Description
200 OK	ThroughputSettingsGetResults	Las RU por segundo de la operación de actualización de tabla se completaron correctamente.
202 Accepted		Las RU por segundo de la operación de actualización de tabla se completarán de forma asincrónica. Encabezados azure-AsyncOperation: string location: string

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Suplantar tu cuenta de usuario

Ejemplos

CosmosDBTableThroughputUpdate

Solicitud de ejemplo

HTTP

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

{
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400
    }
  }
}

Java

import com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource;
import com.azure.resourcemanager.cosmos.models.ThroughputSettingsUpdateParameters;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for TableResources UpdateTableThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBTableThroughputUpdate.json
     */
    /**
     * Sample code: CosmosDBTableThroughputUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBTableThroughputUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getTableResources().updateTableThroughput(
            "rg1", "ddb1", "tableName", new ThroughputSettingsUpdateParameters().withLocation("West US")
                .withTags(mapOf()).withResource(new ThroughputSettingsResource().withThroughput(400)),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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_throughput_update.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_update_table_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        table_name="tableName",
        update_throughput_parameters={
            "location": "West US",
            "properties": {"resource": {"throughput": 400}},
            "tags": {},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBTableThroughputUpdate.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/azcore/to"
	"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/CosmosDBTableThroughputUpdate.json
func ExampleTableResourcesClient_BeginUpdateTableThroughput() {
	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().BeginUpdateTableThroughput(ctx, "rg1", "ddb1", "tableName", armcosmos.ThroughputSettingsUpdateParameters{
		Location: to.Ptr("West US"),
		Tags:     map[string]*string{},
		Properties: &armcosmos.ThroughputSettingsUpdateProperties{
			Resource: &armcosmos.ThroughputSettingsResource{
				Throughput: to.Ptr[int32](400),
			},
		},
	}, 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{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/throughputSettings/default"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Properties: &armcosmos.ThroughputSettingsGetProperties{
	// 		Resource: &armcosmos.ThroughputSettingsGetPropertiesResource{
	// 			Etag: to.Ptr("\"00005900-0000-0000-0000-56f9a2630000\""),
	// 			Rid: to.Ptr("PD5DALigDgw="),
	// 			Ts: to.Ptr[float32](1459200611),
	// 			MinimumThroughput: to.Ptr("400"),
	// 			OfferReplacePending: to.Ptr("true"),
	// 			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 Update RUs per second of an Azure Cosmos DB Table
 *
 * @summary Update RUs per second of an Azure Cosmos DB Table
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBTableThroughputUpdate.json
 */
async function cosmosDbTableThroughputUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const tableName = "tableName";
  const updateThroughputParameters = {
    location: "West US",
    resource: { throughput: 400 },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.tableResources.beginUpdateTableThroughputAndWait(
    resourceGroupName,
    accountName,
    tableName,
    updateThroughputParameters,
  );
  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

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings",
  "location": "West US",
  "tags": {},
  "properties": {
    "resource": {
      "throughput": 400,
      "minimumThroughput": "400",
      "offerReplacePending": "true",
      "_rid": "PD5DALigDgw=",
      "_ts": 1459200611,
      "_etag": "\"00005900-0000-0000-0000-56f9a2630000\""
    }
  }
}

status code:

202

Definiciones

Nombre	Description
AutoscaleSettingsResource	Objeto de configuración de rendimiento aprovisionado de Cosmos DB
AutoUpgradePolicyResource	Directiva de actualización automática de recursos de Cosmos DB
Resource
ThroughputPolicyResource	Directiva de rendimiento de recursos de Cosmos DB
ThroughputSettingsGetResults	Rendimiento de recursos de Azure Cosmos DB.
ThroughputSettingsResource	Objeto de rendimiento de recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.
ThroughputSettingsUpdateParameters	Parámetros que se van a proporcionar para las RU por segundo de la tabla actual.

AutoscaleSettingsResource

Object

Objeto de configuración de rendimiento aprovisionado de Cosmos DB

Nombre	Tipo	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Directiva de actualización automática de recursos de Cosmos DB
maxThroughput	integer	Representa el contenedor de rendimiento máximo al que se puede escalar verticalmente.
targetMaxThroughput	integer	Representa el contenedor de rendimiento máximo de destino que se puede escalar verticalmente una vez que la oferta ya no está en estado pendiente.

AutoUpgradePolicyResource

Object

Directiva de actualización automática de recursos de Cosmos DB

Nombre	Tipo	Description
throughputPolicy	ThroughputPolicyResource	Representa la directiva de rendimiento a la que debe cumplir el servicio para la actualización automática.

Resource

Object

Nombre	Tipo	Description
_etag	string	Propiedad generada por el sistema que representa la etag de recursos necesaria para el control de simultaneidad optimista.
_rid	string	Propiedad generada por el sistema. Identificador único.
_ts	number	Propiedad generada por el sistema que denota la última marca de tiempo actualizada del recurso.
autoscaleSettings	AutoscaleSettingsResource	Recurso de Cosmos DB para la configuración de escalabilidad automática. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.
instantMaximumThroughput	string	Valor de rendimiento de la oferta para escalar verticalmente al instante sin desencadenar divisiones
minimumThroughput	string	Rendimiento mínimo del recurso
offerReplacePending	string	El reemplazo del rendimiento está pendiente
softAllowedMaximumThroughput	string	Valor máximo de rendimiento o valor máximo de maxThroughput (para escalabilidad automática) que se puede especificar.
throughput	integer	Valor del rendimiento del recurso de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.

ThroughputPolicyResource

Object

Directiva de rendimiento de recursos de Cosmos DB

Nombre	Tipo	Description
incrementPercent	integer	Representa el porcentaje por el que el rendimiento puede aumentar cada vez que se inicia la directiva de rendimiento.
isEnabled	boolean	Determina si la propiedad ThroughputPolicy está activa o no.

ThroughputSettingsGetResults

Object

Rendimiento de recursos de Azure Cosmos DB.

Nombre	Tipo	Description
id	string	Identificador de recurso único del recurso de ARM.
location	string	The location of the resource group to which the resource belongs.
name	string	Nombre del recurso de ARM.
properties.resource	Resource
tags	object	Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas se pueden usar para ver y agrupar este recurso (entre grupos de recursos). Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y el valor no mayor que 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB".
type	string	Tipo de recurso de Azure.

ThroughputSettingsResource

Object

Objeto de rendimiento de recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.

Nombre	Tipo	Description
autoscaleSettings	AutoscaleSettingsResource	Recurso de Cosmos DB para la configuración de escalabilidad automática. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.
instantMaximumThroughput	string	Valor de rendimiento de la oferta para escalar verticalmente al instante sin desencadenar divisiones
minimumThroughput	string	Rendimiento mínimo del recurso
offerReplacePending	string	El reemplazo del rendimiento está pendiente
softAllowedMaximumThroughput	string	Valor máximo de rendimiento o valor máximo de maxThroughput (para escalabilidad automática) que se puede especificar.
throughput	integer	Valor del rendimiento del recurso de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.

ThroughputSettingsUpdateParameters

Object

Parámetros que se van a proporcionar para las RU por segundo de la tabla actual.

Nombre	Tipo	Description
id	string	Identificador de recurso único del recurso de ARM.
location	string	The location of the resource group to which the resource belongs.
name	string	Nombre del recurso de ARM.
properties.resource	ThroughputSettingsResource	El formato JSON estándar de un rendimiento de recursos
tags	object	Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas se pueden usar para ver y agrupar este recurso (entre grupos de recursos). Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y el valor no mayor que 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB".
type	string	Tipo de recurso de Azure.