CosmosDBExtensions.GetCosmosDBThroughputPoolsAsync 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.
Lists all the Azure Cosmos DB Throughput Pools available under the subscription.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/throughputPools
- Operation Id: ThroughputPools_List
- Default Api Version: 2024-09-01-preview
- Resource: CosmosDBThroughputPoolResource
public static Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource> GetCosmosDBThroughputPoolsAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);
static member GetCosmosDBThroughputPoolsAsync : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.CosmosDBThroughputPoolResource>
<Extension()>
Public Function GetCosmosDBThroughputPoolsAsync (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of CosmosDBThroughputPoolResource)
Parameters
- subscriptionResource
- SubscriptionResource
The SubscriptionResource instance the method will execute against.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
An async collection of CosmosDBThroughputPoolResource that may take multiple service requests to iterate over.
Exceptions
subscriptionResource
is null.