Mongo DB Resources - Update Mongo DB Database Throughput

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Actualización de ru por segundo de una base de datos de MongoDB de Azure Cosmos DB

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default?api-version=2023-11-15

Parámetros de identificador URI

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

Cuerpo de la solicitud

Nombre	Tipo	Description
updateThroughputParameters	ThroughputSettingsUpdateParameters	Las RU por segundo de los parámetros que se van a proporcionar para la base de datos de MongoDB actual.

Respuestas

Nombre	Tipo	Description
200 OK	ThroughputSettingsGetResults	Las RU por segundo de la operación de actualización de base de datos de MongoDB se completaron correctamente.
202 Accepted		Las RU por segundo de la operación de actualización de base de datos de MongoDB se completarán de forma asincrónica. Headers azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Ejemplos

CosmosDBMongoDBDatabaseThroughputUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default?api-version=2023-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 MongoDBResources UpdateMongoDBDatabaseThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/
     * CosmosDBMongoDBDatabaseThroughputUpdate.json
     */
    /**
     * Sample code: CosmosDBMongoDBDatabaseThroughputUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBDatabaseThroughputUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().updateMongoDBDatabaseThroughput(
            "rg1", "ddb1", "databaseName", 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_mongo_db_database_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.mongo_db_resources.begin_update_mongo_db_database_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
        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/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/41e4538ed7bb3ceac3c1322c9455a0812ed110ac/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json
func ExampleMongoDBResourcesClient_BeginUpdateMongoDBDatabaseThroughput() {
	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.NewMongoDBResourcesClient().BeginUpdateMongoDBDatabaseThroughput(ctx, "rg1", "ddb1", "databaseName", 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/mongodbDatabases/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/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");

/**
 * This sample demonstrates how to Update RUs per second of the an Azure Cosmos DB MongoDB database
 *
 * @summary Update RUs per second of the an Azure Cosmos DB MongoDB database
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2023-11-15/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json
 */
async function cosmosDbMongoDbdatabaseThroughputUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rg1";
  const accountName = "ddb1";
  const databaseName = "databaseName";
  const updateThroughputParameters = {
    location: "West US",
    resource: { throughput: 400 },
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.mongoDBResources.beginUpdateMongoDBDatabaseThroughputAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default",
  "name": "default",
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/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
CloudError	Respuesta de error del servicio.
ErrorResponse	Respuesta de error.
Resource
ThroughputPolicyResource	Directiva de rendimiento de recursos de Cosmos DB
ThroughputSettingsGetResults	Un 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	Las RU por segundo de los parámetros que se van a proporcionar para la base de datos de MongoDB actual.

AutoscaleSettingsResource

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

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

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

CloudError

Respuesta de error del servicio.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

Resource

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 indica 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	El valor de rendimiento máximo o el valor máximo de maxThroughput (para la escalabilidad automática) que se puede especificar.
throughput	integer	Valor del rendimiento de los recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.

ThroughputPolicyResource

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 ThroughputPolicy está activo o no.

ThroughputSettingsGetResults

Un rendimiento de recursos de Azure Cosmos DB.

Nombre	Tipo	Description
id	string	Identificador de recurso único del recurso de ARM.
location	string	Ubicación del grupo de recursos al que pertenece el recurso.
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 pueden utilizarse para visualizar y agrupar este recurso a través de 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 un valor no superior a 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

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	El valor de rendimiento máximo o el valor máximo de maxThroughput (para la escalabilidad automática) que se puede especificar.
throughput	integer	Valor del rendimiento de los recursos de Cosmos DB. Se requiere el rendimiento o se requiere autoscaleSettings, pero no ambos.

ThroughputSettingsUpdateParameters

Las RU por segundo de los parámetros que se van a proporcionar para la base de datos de MongoDB actual.

Nombre	Tipo	Description
id	string	Identificador de recurso único del recurso de ARM.
location	string	Ubicación del grupo de recursos al que pertenece el recurso.
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 pueden utilizarse para visualizar y agrupar este recurso a través de 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 un valor no superior a 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.