CosmosDBSqlDatabaseThroughputSettingResource.SqlDatabaseRedistributeThroughput Method
Definition
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 SQL database
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/redistributeThroughput
- Operation Id: SqlResources_SqlDatabaseRedistributeThroughput
- Default Api Version: 2024-09-01-preview
- Resource: CosmosDBSqlDatabaseThroughputSettingResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult> SqlDatabaseRedistributeThroughput (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RedistributeThroughputParameters redistributeThroughputParameters, System.Threading.CancellationToken cancellationToken = default);
abstract member SqlDatabaseRedistributeThroughput : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RedistributeThroughputParameters * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>
override this.SqlDatabaseRedistributeThroughput : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RedistributeThroughputParameters * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>
Public Overridable Function SqlDatabaseRedistributeThroughput (waitUntil As WaitUntil, redistributeThroughputParameters As RedistributeThroughputParameters, Optional cancellationToken As CancellationToken = Nothing) As 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 SQL database.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
redistributeThroughputParameters
is null.