Mongo DB Resources - Update Mongo DB Collection Throughput

Referencia

Szolgáltatás:: Cosmos DB Resource Provider

API-verzió:: 2024-11-15

Az Azure Cosmos DB MongoDB-gyűjtemény másodpercenkénti kérelemegységeinek frissítése

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB-adatbázisfiók neve.
collectionName	path	True	string	Cosmos DB-gyűjtemény neve.
databaseName	path	True	string	Cosmos DB-adatbázis neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Típus	Description
updateThroughputParameters	ThroughputSettingsUpdateParameters	Az aktuális MongoDB-gyűjteményhez megadható paraméterek másodpercenkénti kérelemegységei.

Válaszok

Name	Típus	Description
200 OK	ThroughputSettingsGetResults	A MongoDB-gyűjtemény frissítési műveletének másodpercenkénti kérelemegységei sikeresen befejeződtek.
202 Accepted		A MongoDB-gyűjtemény frissítési műveletének másodpercenkénti kérelemegységei aszinkron módon fejeződnek be. Fejlécek azure-AsyncOperation: string location: string

Name

Típus

Description

200 OK

ThroughputSettingsGetResults

A MongoDB-gyűjtemény frissítési műveletének másodpercenkénti kérelemegységei sikeresen befejeződtek.

202 Accepted

A MongoDB-gyűjtemény frissítési műveletének másodpercenkénti kérelemegységei aszinkron módon fejeződnek be.

Fejlécek

azure-AsyncOperation: string
location: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	A felhasználói fiók megszemélyesítése

Példák

CosmosDBMongoDBCollectionThroughputUpdate

Mintakérelem

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/collections/collectionName/throughputSettings/default?api-version=2024-11-15

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


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 UpdateMongoDBCollectionThroughput.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-11-15/examples/
     * CosmosDBMongoDBCollectionThroughputUpdate.json
     */
    /**
     * Sample code: CosmosDBMongoDBCollectionThroughputUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBMongoDBCollectionThroughputUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getMongoDBResources().updateMongoDBCollectionThroughput(
            "rg1", "ddb1", "databaseName", "collectionName",
            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

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_collection_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_collection_throughput(
        resource_group_name="rg1",
        account_name="ddb1",
        database_name="databaseName",
        collection_name="collectionName",
        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/CosmosDBMongoDBCollectionThroughputUpdate.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

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/CosmosDBMongoDBCollectionThroughputUpdate.json
func ExampleMongoDBResourcesClient_BeginUpdateMongoDBCollectionThroughput() {
	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().BeginUpdateMongoDBCollectionThroughput(ctx, "rg1", "ddb1", "databaseName", "collectionName", 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/mongodbCollections/throughputSettings"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName/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

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");

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

Mintaválasz

Állapotkód:: 200

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

Állapotkód:: 202

Definíciók

Name	Description
AutoscaleSettingsResource	A Cosmos DB által kiosztott átviteli sebesség beállítási objektuma
AutoUpgradePolicyResource	Cosmos DB-erőforrás automatikus frissítési szabályzata
Resource
ThroughputPolicyResource	Cosmos DB-erőforrás átviteli sebességének szabályzata
ThroughputSettingsGetResults	Egy Azure Cosmos DB-erőforrás átviteli sebessége.
ThroughputSettingsResource	Cosmos DB-erőforrás átviteli sebesség objektuma. Vagy az átviteli sebességre van szükség, vagy az automatikus skálázási beállításokra van szükség, de mindkettőre nem.
ThroughputSettingsUpdateParameters	Az aktuális MongoDB-gyűjteményhez megadható paraméterek másodpercenkénti kérelemegységei.

AutoscaleSettingsResource

Objektum

A Cosmos DB által kiosztott átviteli sebesség beállítási objektuma

Name	Típus	Description
autoUpgradePolicy	AutoUpgradePolicyResource	Cosmos DB-erőforrás automatikus frissítési szabályzata
maxThroughput	integer	A maximális átviteli sebesség tárolója, amely vertikálisan felskálázható.
targetMaxThroughput	integer	A cél maximális átviteli sebesség tárolója felskálázható, ha az ajánlat már nincs függőben állapotban.

AutoUpgradePolicyResource

Objektum

Cosmos DB-erőforrás automatikus frissítési szabályzata

Name	Típus	Description
throughputPolicy	ThroughputPolicyResource	Azt az átviteli sebességet jelző házirendet jelöli, amelyhez a szolgáltatásnak be kell tartania az automatikus frissítést

Resource

Objektum

Name	Típus	Description
_etag	string	Egy rendszer által létrehozott tulajdonság, amely az optimista egyidejűség-vezérléshez szükséges erőforrás-etagot jelöli.
_rid	string	Rendszer által létrehozott tulajdonság. Egyedi azonosító.
_ts	number	Egy rendszer által létrehozott tulajdonság, amely az erőforrás utolsó frissített időbélyegét jelöli.
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-erőforrás automatikus méretezési beállításokhoz. Vagy az átviteli sebességre van szükség, vagy az automatikus skálázási beállításokra van szükség, de mindkettőre nem.
instantMaximumThroughput	string	Az ajánlat átviteli sebességének értéke a felskálázás azonnali aktiválása nélkül
minimumThroughput	string	Az erőforrás minimális átviteli sebessége
offerReplacePending	string	Az átviteli sebesség cseréje függőben van
softAllowedMaximumThroughput	string	A maximális átviteli sebesség vagy a maximális maximális átviteli sebesség (automatikus skálázás esetén), amely megadható
throughput	integer	A Cosmos DB-erőforrás átviteli sebességének értéke. Vagy az átviteli sebességre van szükség, vagy az automatikus skálázási beállításokra van szükség, de mindkettőre nem.

ThroughputPolicyResource

Objektum

Cosmos DB-erőforrás átviteli sebességének szabályzata

Name	Típus	Description
incrementPercent	integer	Azt a százalékot jelöli, amellyel az átviteli sebesség minden alkalommal növekedhet, amikor az átviteli sebesség házirendje elindul.
isEnabled	boolean	Meghatározza, hogy a ThroughputPolicy aktív-e vagy sem

ThroughputSettingsGetResults

Objektum

Egy Azure Cosmos DB-erőforrás átviteli sebessége.

Name	Típus	Description
id	string	Az ARM-erőforrás egyedi erőforrás-azonosítója.
location	string	Annak az erőforráscsoportnak a helye, amelyhez az erőforrás tartozik.
name	string	Az ARM-erőforrás neve.
properties.resource	Resource
tags	object	A címkék az erőforrást leíró kulcs-érték párok listája. Ezek a címkék használhatók az erőforrás megtekintéséhez és csoportosításához (erőforráscsoportok között). Egy erőforráshoz legfeljebb 15 címke adható meg. Minden címkének 128 karakternél nem nagyobb és 256 karakternél nem nagyobb értékű kulcsnak kell lennie. Egy sablontípus alapértelmezett felülete például "defaultExperience": "Cassandra". A jelenlegi "defaultExperience" értékek közé tartozik a "Table", a "Graph", a "DocumentDB" és a "MongoDB".
type	string	Az Azure-erőforrás típusa.

ThroughputSettingsResource

Objektum

Cosmos DB-erőforrás átviteli sebesség objektuma. Vagy az átviteli sebességre van szükség, vagy az automatikus skálázási beállításokra van szükség, de mindkettőre nem.

Name	Típus	Description
autoscaleSettings	AutoscaleSettingsResource	Cosmos DB-erőforrás automatikus méretezési beállításokhoz. Vagy az átviteli sebességre van szükség, vagy az automatikus skálázási beállításokra van szükség, de mindkettőre nem.
instantMaximumThroughput	string	Az ajánlat átviteli sebességének értéke a felskálázás azonnali aktiválása nélkül
minimumThroughput	string	Az erőforrás minimális átviteli sebessége
offerReplacePending	string	Az átviteli sebesség cseréje függőben van
softAllowedMaximumThroughput	string	A maximális átviteli sebesség vagy a maximális maximális átviteli sebesség (automatikus skálázás esetén), amely megadható
throughput	integer	A Cosmos DB-erőforrás átviteli sebességének értéke. Vagy az átviteli sebességre van szükség, vagy az automatikus skálázási beállításokra van szükség, de mindkettőre nem.

ThroughputSettingsUpdateParameters

Objektum

Az aktuális MongoDB-gyűjteményhez megadható paraméterek másodpercenkénti kérelemegységei.

Name	Típus	Description
id	string	Az ARM-erőforrás egyedi erőforrás-azonosítója.
location	string	Annak az erőforráscsoportnak a helye, amelyhez az erőforrás tartozik.
name	string	Az ARM-erőforrás neve.
properties.resource	ThroughputSettingsResource	Az erőforrás-átviteli sebesség szabványos JSON-formátuma
tags	object	A címkék az erőforrást leíró kulcs-érték párok listája. Ezek a címkék használhatók az erőforrás megtekintéséhez és csoportosításához (erőforráscsoportok között). Egy erőforráshoz legfeljebb 15 címke adható meg. Minden címkének 128 karakternél nem nagyobb és 256 karakternél nem nagyobb értékű kulcsnak kell lennie. Egy sablontípus alapértelmezett felülete például "defaultExperience": "Cassandra". A jelenlegi "defaultExperience" értékek közé tartozik a "Table", a "Graph", a "DocumentDB" és a "MongoDB".
type	string	Az Azure-erőforrás típusa.

Megosztás a következőn keresztül:

Mongo DB Resources - Update Mongo DB Collection Throughput

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

CosmosDBMongoDBCollectionThroughputUpdate

Mintakérelem

Mintaválasz

Definíciók

AutoscaleSettingsResource

AutoUpgradePolicyResource

Resource

ThroughputPolicyResource

ThroughputSettingsGetResults

ThroughputSettingsResource

ThroughputSettingsUpdateParameters