Mongo DB Resources - Update Mongo DB Database Throughput

Service:

Cosmos DB Resource Provider

API Version:

2023-11-15

Aggiornare le UR al secondo di un database MongoDB di 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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account del database Cosmos DB. Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*
databaseName	path	True	string	Nome del database Cosmos DB.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
updateThroughputParameters	ThroughputSettingsUpdateParameters	Ur al secondo dei parametri da fornire per il database MongoDB corrente.

Risposte

Nome	Tipo	Descrizione
200 OK	ThroughputSettingsGetResults	Le UR al secondo dell'operazione di aggiornamento del database MongoDB sono state completate correttamente.
202 Accepted		Le UR al secondo dell'operazione di aggiornamento del database MongoDB verranno completate in modo asincrono. Headers azure-AsyncOperation: string location: string
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
AutoscaleSettingsResource	Oggetto impostazioni velocità effettiva con provisioning di Cosmos DB
AutoUpgradePolicyResource	Criteri di aggiornamento automatico delle risorse di Cosmos DB
CloudError	Risposta di errore dal servizio.
ErrorResponse	Risposta errore.
Resource
ThroughputPolicyResource	Criteri di velocità effettiva delle risorse di Cosmos DB
ThroughputSettingsGetResults	Velocità effettiva delle risorse di Azure Cosmos DB.
ThroughputSettingsResource	Oggetto velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.
ThroughputSettingsUpdateParameters	Ur al secondo dei parametri da fornire per il database MongoDB corrente.

AutoscaleSettingsResource

Oggetto impostazioni velocità effettiva con provisioning di Cosmos DB

Nome	Tipo	Descrizione
autoUpgradePolicy	AutoUpgradePolicyResource	Criteri di aggiornamento automatico delle risorse di Cosmos DB
maxThroughput	integer	Rappresenta il contenitore di velocità effettiva massima in grado di aumentare le prestazioni.
targetMaxThroughput	integer	Rappresenta il contenitore di velocità effettiva massima di destinazione che può aumentare fino a una volta che l'offerta non è più in sospeso.

AutoUpgradePolicyResource

Criteri di aggiornamento automatico delle risorse di Cosmos DB

Nome	Tipo	Descrizione
throughputPolicy	ThroughputPolicyResource	Rappresenta i criteri di velocità effettiva che il servizio deve rispettare per l'aggiornamento automatico

CloudError

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta errore.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

Resource

Nome	Tipo	Descrizione
_etag	string	Proprietà generata dal sistema che rappresenta l'etag della risorsa necessaria per il controllo della concorrenza ottimistica.
_rid	string	Proprietà generata dal sistema. Identificatore univoco.
_ts	number	Proprietà generata dal sistema che indica il timestamp dell'ultimo aggiornamento della risorsa.
autoscaleSettings	AutoscaleSettingsResource	Risorsa Cosmos DB per le impostazioni di scalabilità automatica. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.
instantMaximumThroughput	string	Valore della velocità effettiva dell'offerta per aumentare immediatamente le prestazioni senza attivare divisioni
minimumThroughput	string	Velocità effettiva minima della risorsa
offerReplacePending	string	La sostituzione della velocità effettiva è in sospeso
softAllowedMaximumThroughput	string	Valore massimo della velocità effettiva o valore massimo maxThroughput (per la scalabilità automatica) che può essere specificato
throughput	integer	Valore della velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

ThroughputPolicyResource

Criteri di velocità effettiva delle risorse di Cosmos DB

Nome	Tipo	Descrizione
incrementPercent	integer	Rappresenta la percentuale in base alla quale la velocità effettiva può aumentare ogni volta che vengono avviati i criteri di velocità effettiva.
isEnabled	boolean	Determina se ThroughputPolicy è attivo o meno

ThroughputSettingsGetResults

Velocità effettiva delle risorse di Azure Cosmos DB.

Nome	Tipo	Descrizione
id	string	Identificatore univoco della risorsa arm.
location	string	Posizione del gruppo di risorse a cui appartiene la risorsa.
name	string	Nome della risorsa arm.
properties.resource	Resource
tags	object	I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".
type	string	Tipo di risorsa di Azure.

ThroughputSettingsResource

Oggetto velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

Nome	Tipo	Descrizione
autoscaleSettings	AutoscaleSettingsResource	Risorsa Cosmos DB per le impostazioni di scalabilità automatica. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.
instantMaximumThroughput	string	Valore della velocità effettiva dell'offerta per aumentare immediatamente le prestazioni senza attivare divisioni
minimumThroughput	string	Velocità effettiva minima della risorsa
offerReplacePending	string	La sostituzione della velocità effettiva è in sospeso
softAllowedMaximumThroughput	string	Valore massimo della velocità effettiva o valore massimo maxThroughput (per la scalabilità automatica) che può essere specificato
throughput	integer	Valore della velocità effettiva delle risorse di Cosmos DB. La velocità effettiva è necessaria o è necessaria la scalabilità automaticaSettings, ma non entrambe.

ThroughputSettingsUpdateParameters

Ur al secondo dei parametri da fornire per il database MongoDB corrente.

Nome	Tipo	Descrizione
id	string	Identificatore univoco della risorsa arm.
location	string	Posizione del gruppo di risorse a cui appartiene la risorsa.
name	string	Nome della risorsa arm.
properties.resource	ThroughputSettingsResource	Formato JSON standard di una velocità effettiva delle risorse
tags	object	I tag sono un elenco di coppie chiave-valore che descrivono la risorsa. Questi tag possono essere utilizzati nella visualizzazione e nel raggruppamento di questa risorsa (tra gruppi di risorse). È possibile specificare un massimo di 15 tag per una risorsa. Ogni tag deve avere una chiave non superiore a 128 caratteri con un valore che non superi i 256 caratteri. Ad esempio, l'esperienza predefinita per un tipo di modello è impostata con "defaultExperience": "Cassandra". I valori correnti "defaultExperience" includono anche "Table", "Graph", "DocumentDB" e "MongoDB".
type	string	Tipo di risorsa di Azure.