SqlResourcesOperations.StartUpdateSqlDatabaseThroughputAsync(String, String, String, ThroughputSettingsUpdateParameters, CancellationToken) Method

Definition

Update RUs per second of an Azure Cosmos DB SQL database.

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.CosmosDB.SqlResourcesUpdateSqlDatabaseThroughputOperation> StartUpdateSqlDatabaseThroughputAsync (string resourceGroupName, string accountName, string databaseName, Azure.ResourceManager.CosmosDB.Models.ThroughputSettingsUpdateParameters updateThroughputParameters, System.Threading.CancellationToken cancellationToken = default);
abstract member StartUpdateSqlDatabaseThroughputAsync : string * string * string * Azure.ResourceManager.CosmosDB.Models.ThroughputSettingsUpdateParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.CosmosDB.SqlResourcesUpdateSqlDatabaseThroughputOperation>
override this.StartUpdateSqlDatabaseThroughputAsync : string * string * string * Azure.ResourceManager.CosmosDB.Models.ThroughputSettingsUpdateParameters * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.CosmosDB.SqlResourcesUpdateSqlDatabaseThroughputOperation>
Public Overridable Function StartUpdateSqlDatabaseThroughputAsync (resourceGroupName As String, accountName As String, databaseName As String, updateThroughputParameters As ThroughputSettingsUpdateParameters, Optional cancellationToken As CancellationToken = Nothing) As Task(Of SqlResourcesUpdateSqlDatabaseThroughputOperation)

Parameters

resourceGroupName
System.String

The name of the resource group. The name is case insensitive.

accountName
System.String

Cosmos DB database account name.

databaseName
System.String

Cosmos DB database name.

updateThroughputParameters
ThroughputSettingsUpdateParameters

The parameters to provide for the RUs per second of the current SQL database.

cancellationToken
System.Threading.CancellationToken

The cancellation token to use.

Returns

System.Threading.Tasks.Task<SqlResourcesUpdateSqlDatabaseThroughputOperation>

Exceptions

System.ArgumentNullException

resourceGroupName, accountName, databaseName, or updateThroughputParameters is null.

Applies to