CosmosDBSqlDatabaseThroughputSettingResource.SqlDatabaseRetrieveThroughputDistribution 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.
Retrieve throughput distribution for an Azure Cosmos DB SQL database
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/retrieveThroughputDistribution
- Operation Id: SqlResources_SqlDatabaseRetrieveThroughputDistribution
- Default Api Version: 2024-09-01-preview
- Resource: CosmosDBSqlDatabaseThroughputSettingResource
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult> SqlDatabaseRetrieveThroughputDistribution (Azure.WaitUntil waitUntil, Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters retrieveThroughputParameters, System.Threading.CancellationToken cancellationToken = default);
abstract member SqlDatabaseRetrieveThroughputDistribution : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>
override this.SqlDatabaseRetrieveThroughputDistribution : Azure.WaitUntil * Azure.ResourceManager.CosmosDB.Models.RetrieveThroughputParameters * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation<Azure.ResourceManager.CosmosDB.Models.PhysicalPartitionThroughputInfoResult>
Public Overridable Function SqlDatabaseRetrieveThroughputDistribution (waitUntil As WaitUntil, retrieveThroughputParameters As RetrieveThroughputParameters, 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.
- retrieveThroughputParameters
- RetrieveThroughputParameters
The parameters to provide for retrieving throughput distribution for the current SQL database.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
retrieveThroughputParameters
is null.
Applies to
Azure SDK for .NET