MongoDBDatabaseThroughputSettingResource.MongoDBDatabaseRedistributeThroughputAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

Package:: Azure.ResourceManager.CosmosDB v1.4.0-beta.8

Source:: MongoDBDatabaseThroughputSettingResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Redistribute throughput for an Azure Cosmos DB MongoDB database

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/redistributeThroughput
Operation Id: MongoDBResources_MongoDBDatabaseRedistributeThroughput
Default Api Version: 2024-02-15-preview
Resource: MongoDBDatabaseThroughputSettingResource

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>> MongoDBDatabaseRedistributeThroughputAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RedistributeThroughputParameters redistributeThroughputParameters, System.Threading.CancellationToken cancellationToken = default);

abstract member MongoDBDatabaseRedistributeThroughputAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RedistributeThroughputParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>>
override this.MongoDBDatabaseRedistributeThroughputAsync : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RedistributeThroughputParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>>

Public Overridable Function MongoDBDatabaseRedistributeThroughputAsync (waitUntil As WaitUntil, redistributeThroughputParameters As RedistributeThroughputParameters, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ArmOperation(Of PhysicalPartitionThroughputInfoResult))

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

redistributeThroughputParameters: RedistributeThroughputParameters

The parameters to provide for redistributing throughput for the current MongoDB database.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<ArmOperation<PhysicalPartitionThroughputInfoResult>>

Exceptions

ArgumentNullException

redistributeThroughputParameters is null.

Applies to