CosmosDBExtensions.GetThroughputPoolResourcesAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDB

Assembly:: Azure.ResourceManager.CosmosDB.dll

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

Source:: CosmosDBExtensions.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.

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-02-15-preview
Resource: ThroughputPoolResource

public static Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.ThroughputPoolResource> GetThroughputPoolResourcesAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);

static member GetThroughputPoolResourcesAsync : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.CosmosDB.ThroughputPoolResource>

<Extension()>
Public Function GetThroughputPoolResourcesAsync (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ThroughputPoolResource)

Parameters

subscriptionResource: SubscriptionResource

The SubscriptionResource instance the method will execute against.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

AsyncPageable<ThroughputPoolResource>

An async collection of ThroughputPoolResource that may take multiple service requests to iterate over.

Exceptions

ArgumentNullException

subscriptionResource is null.

Applies to