Cassandra Resources - Update Cassandra Table Throughput

Serviço:

Cosmos DB Resource Provider

Versão da API:

2024-11-15

Atualizar RUs por segundo de uma tabela Cassandra do Azure Cosmos DB

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	Nome da conta do banco de dados do Cosmos DB. Padrão Regex: ^[a-z0-9]+(-[a-z0-9]+)*
keyspaceName	path	True	string	Nome do espaço de chave do Cosmos DB.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
tableName	path	True	string	Nome da tabela do Cosmos DB.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.resource	True	ThroughputSettingsResource	O formato JSON padrão de uma taxa de transferência de recursos
location		string	O local do grupo de recursos ao qual o recurso pertence.
tags		object	As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 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".

Respostas

Name	Tipo	Description
200 OK	ThroughputSettingsGetResults	As RUs por segundo da operação de atualização da tabela Cassandra foram concluídas com êxito.
202 Accepted		As RUs por segundo da operação de atualização da tabela Cassandra serão concluídas de forma assíncrona. Cabeçalhos azure-AsyncOperation: string location: string

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Exemplos

CosmosDBCassandraTableThroughputUpdate

Pedido de amostra

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/tables/tableName/throughputSettings/default?api-version=2024-11-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 CassandraResources UpdateCassandraTableThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
     * CosmosDBCassandraTableThroughputUpdate.json
     */
    /**
     * Sample code: CosmosDBCassandraTableThroughputUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBCassandraTableThroughputUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getCassandraResources().updateCassandraTableThroughput("rg1",
            "ddb1", "keyspaceName", "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_cassandra_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.cassandra_resources.begin_update_cassandra_table_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        keyspace_name="keyspaceName",
        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/2024-11-15/examples/CosmosDBCassandraTableThroughputUpdate.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/ded6306d00ae294c24211e5069c1f56b15ba8ef5/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBCassandraTableThroughputUpdate.json
func ExampleCassandraResourcesClient_BeginUpdateCassandraTableThroughput() {
	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.NewCassandraResourcesClient().BeginUpdateCassandraTableThroughput(ctx, "rg1", "ddb1", "keyspaceName", "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/cassandraKeyspaces/cassandraTables/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName/throughputSettings/default"),
	// 	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");

/**
 * This sample demonstrates how to Update RUs per second of an Azure Cosmos DB Cassandra table
 *
 * @summary Update RUs per second of an Azure Cosmos DB Cassandra table
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/CosmosDBCassandraTableThroughputUpdate.json
 */
async function cosmosDbCassandraTableThroughputUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const keyspaceName = "keyspaceName";
  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.cassandraResources.beginUpdateCassandraTableThroughputAndWait(
    resourceGroupName,
    accountName,
    keyspaceName,
    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

Resposta da amostra

Código de estado:

200

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

Código de estado:

202

Definições

Name	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
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.
ThroughputSettingsResource	Objeto de taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos.
ThroughputSettingsUpdateParameters	Parâmetros para atualizar a taxa de transferência de recursos do Cosmos DB.

AutoscaleSettingsResource

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

Name	Tipo	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Política de atualização automática de recursos do Cosmos DB
maxThroughput	integer	Representa a taxa de transferência máxima que o contêiner pode dimensionar.
targetMaxThroughput	integer	Representa o contêiner de taxa de transferência máxima de destino que pode ser dimensionado até quando a oferta não estiver mais no estado pendente.

AutoUpgradePolicyResource

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

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

Resource

Name	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 único.
_ts	number	Uma propriedade gerada pelo sistema que indica o carimbo de data/hora da última atualização do recurso.
autoscaleSettings	AutoscaleSettingsResource	Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos.
instantMaximumThroughput	string	O valor da taxa de transferência da oferta para aumentar instantaneamente a escala sem acionar divisões
minimumThroughput	string	A taxa de transferência mínima do recurso
offerReplacePending	string	A substituição da taxa de transferência está pendente
softAllowedMaximumThroughput	string	O valor máximo de taxa de transferência ou o valor máximo de taxa de transferência máxima (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 autoscaleSettings é necessário, mas não ambos.

ThroughputPolicyResource

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

Name	Tipo	Description
incrementPercent	integer	Representa a porcentagem pela qual a taxa de transferência pode aumentar sempre que a política de taxa de transferência é iniciada.
isEnabled	boolean	Determina se a ThroughputPolicy está ativa ou não

ThroughputSettingsGetResults

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

Name	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso ARM.
location	string	O local do grupo de recursos ao qual o recurso pertence.
name	string	O nome do recurso ARM.
properties.resource	Resource
tags	object	As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 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.

ThroughputSettingsResource

Objeto de taxa de transferência de recursos do Cosmos DB. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos.

Name	Tipo	Description
autoscaleSettings	AutoscaleSettingsResource	Recurso do Cosmos DB para configurações de dimensionamento automático. A taxa de transferência é necessária ou o autoscaleSettings é necessário, mas não ambos.
instantMaximumThroughput	string	O valor da taxa de transferência da oferta para aumentar instantaneamente a escala sem acionar divisões
minimumThroughput	string	A taxa de transferência mínima do recurso
offerReplacePending	string	A substituição da taxa de transferência está pendente
softAllowedMaximumThroughput	string	O valor máximo de taxa de transferência ou o valor máximo de taxa de transferência máxima (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 autoscaleSettings é necessário, mas não ambos.

ThroughputSettingsUpdateParameters

Parâmetros para atualizar a taxa de transferência de recursos do Cosmos DB.

Name	Tipo	Description
id	string	O identificador de recurso exclusivo do recurso ARM.
location	string	O local do grupo de recursos ao qual o recurso pertence.
name	string	O nome do recurso ARM.
properties.resource	ThroughputSettingsResource	O formato JSON padrão de uma taxa de transferência de recursos
tags	object	As tags são uma lista de pares chave-valor que descrevem o recurso. Essas tags podem ser usadas para visualizar e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 tags podem ser fornecidas para um recurso. Cada tag deve ter uma chave não superior a 128 caracteres e um valor não superior a 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.